|
| 1 | +## Contribution Guidelines |
| 2 | + |
| 3 | +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. |
| 4 | + |
| 5 | +## How to contribute |
| 6 | + |
| 7 | +- Decide which repository to contribute |
| 8 | +- Decide what to contribute |
| 9 | +- Fork the repo then clone it locally |
| 10 | +- Commit your work (You should create a new branch when you're doing development work that is somewhat experimental in nature.) |
| 11 | +- Create a **Pull Request** |
| 12 | +- Congrats 🎉 you have just contributed towards open source! |
| 13 | + |
| 14 | +## What to contribute |
| 15 | + |
| 16 | +- Find an open issue to tackle |
| 17 | +- Ask if you can help write a new feature |
| 18 | +- Add / Improve Unit Testing |
| 19 | +- Write tutorials for how a project can be used and add to the readme |
| 20 | +- Review code on other people’s submissions and help improving / finding vulnerabilities |
| 21 | + |
| 22 | +## Making a PR |
| 23 | +- Provide all the appropriate details asked in PR template |
| 24 | +- A pull request doesn’t have to represent finished work. It’s usually better to open a pull request early on, so others can watch or give feedback on your progress. Just mark it as a “WIP” (Work in Progress) in the subject line. You can always add more commits later. |
| 25 | + |
| 26 | +## Opening an Issue |
| 27 | +- Make use of an appropriate Issue Template |
| 28 | +- We welcome Feature request, Bug Report, Documentation fix and others |
| 29 | +- Do not open critical security issues here, report them directly at [our email ](mailto:[email protected]). |
| 30 | + |
| 31 | +## Communicating effectively |
| 32 | +**Give context.** Help others get quickly up to speed. If you’re running into an error, explain what you’re trying to do and how to reproduce it. If you’re suggesting a new idea, explain why you think it’d be useful to the project (not just to you!). |
| 33 | + |
| 34 | +``` |
| 35 | +✔️ “X doesn’t happen when I do Y” |
| 36 | +❌ “X is broken! Please fix it.” |
| 37 | +``` |
| 38 | + |
| 39 | +**Do your homework beforehand.** It’s OK not to know things, but show that you tried. Before asking for help, be sure to check a project’s README, documentation, issues (open or closed), mailing list, and search the internet for an answer. People will appreciate when you demonstrate that you’re trying to learn. |
| 40 | + |
| 41 | +``` |
| 42 | +✔️ ““I’m not sure how to implement X. I checked the help docs and didn’t find any mentions.”” |
| 43 | +❌ “How do I X?” |
| 44 | +``` |
| 45 | + |
| 46 | +**Keep requests short and direct.** |
| 47 | + |
| 48 | +``` |
| 49 | +✔️ “I’d like to write an API tutorial.” |
| 50 | +❌ “I was driving down the highway the other day and stopped for gas, and then I had this amazing idea for something we should be doing, but before I explain that, let me show you…“ |
| 51 | +``` |
| 52 | + |
| 53 | +**It’s okay to ask questions (but be patient!).** |
| 54 | + |
| 55 | +``` |
| 56 | +✔️ “Thanks for looking into this error. I followed your suggestions. Here’s the output.” |
| 57 | +❌ “Why can’t you fix my problem? Isn’t this your project?” |
| 58 | +``` |
| 59 | + |
| 60 | +**Respect community decisions.** |
| 61 | + |
| 62 | +``` |
| 63 | +✔️ “I’m disappointed you can’t support my use case, but as you’ve explained it only affects a minor portion of users, I understand why. Thanks for listening.” |
| 64 | +❌ “Why won’t you support my use case? This is unacceptable!” |
| 65 | +``` |
| 66 | + |
| 67 | +## Misc |
| 68 | +- You are welcome to Propose a new feature by creating an **Issue**. |
| 69 | +- You may Discuss a high-level topic or idea (for example, community, vision or policies) by writing to us at our [Email ](mailto:[email protected]). |
| 70 | + |
| 71 | +## Attribution |
| 72 | +- [Open Source Guide](https://opensource.guide/how-to-contribute/) |
0 commit comments