Skip to content

Commit

Permalink
feat: add CONTRIBUTING file
Browse files Browse the repository at this point in the history
  • Loading branch information
Alireza Akbarzadeh authored and Alireza Akbarzadeh committed Apr 24, 2024
1 parent ba724f8 commit 898ba50
Showing 1 changed file with 71 additions and 0 deletions.
71 changes: 71 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Contributing to [react-launchpad]

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

• Reporting a bug

• Discussing the current state of the code

• Submitting a fix

• Proposing new features

• Becoming a maintainer


## We Develop with Github

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

## We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

## Any contributions you make will be under the Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

## Write bug reports with detail, background, and sample code

[**Great Bug Reports**](https://www.bing.com/search?form=SKPBOT&q=Great%20Bug%20Reports) tend to have:

• A quick summary and/or background

• Steps to reproduce

• Be specific!

• Give sample code if you can.

• What you expected would happen

• What actually happens

• Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)


People *love* thorough bug reports.

## Use a Consistent Coding Style

* 2 spaces for indentation rather than tabs
* You can try running `npm run lint` for style unification

## License

By contributing, you agree that your contributions will be licensed under its MIT License.

## References

This document was adapted from the open-source contribution guidelines for Facebook's Draft.

0 comments on commit 898ba50

Please sign in to comment.