-
-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f2bca6f
commit 6453f39
Showing
1 changed file
with
62 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,137 +1,109 @@ | ||
| # Contributing Guidelines | ||
| # Contribution Guidelines | ||
|
|
||
| *Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!* :octocat: | ||
| ## Welcome Contributors! :octocat: | ||
|
|
||
| > **This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.** | ||
| Thank you for considering contributing to our project. Your contributions are highly valued, and this guide is designed to ensure a smooth and collaborative experience for everyone involved. By following these guidelines, we aim to create a positive and inclusive space for all contributors and maintainers. | ||
|
|
||
| ### :beetle: Bug Reports and Other Issues | ||
| --- | ||
|
|
||
| A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report. :v: | ||
| ## :beetle: Bug Reports and Issue Submissions | ||
|
|
||
| ## :love_letter: Feature Requests | ||
|
|
||
| Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted. We want to avoid [feature creep](https://en.wikipedia.org/wiki/Feature_creep). Your idea may be great, but also out-of-scope for the project. If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are welcome to submit a pull request to help! | ||
|
|
||
| - **Do not open a duplicate feature request.** Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue. | ||
| Reporting bugs or submitting detailed issues is a valuable way to contribute to the project. We appreciate well-written bug reports that include thorough information. To ensure a productive conversation, please adhere to the following: | ||
|
|
||
| - **Fully complete the provided issue template.** The feature request template asks for all necessary information for us to begin a productive conversation. | ||
| ### Guidelines: | ||
|
|
||
| - Be precise about the proposed outcome of the feature and how it relates to existing features. Include implementation details if possible. | ||
|
|
||
| ## :mag: Triaging Issues | ||
| 1. Provide a clear and detailed description of the issue. | ||
| 2. Utilize the issue template provided to include all necessary information. | ||
| 3. Avoid opening duplicate issues; check for existing reports first and comment on those if applicable. | ||
|
|
||
| You can triage issues which may include reproducing bug reports or asking for additional information, such as version numbers or reproduction instructions. Any help you can provide to quickly resolve an issue is very much appreciated! | ||
| --- | ||
|
|
||
| ## :repeat: Submitting Pull Requests | ||
| ## :love_letter: Feature Requests | ||
|
|
||
| We **love** pull requests! Before [forking the repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests) for non-trivial changes, it is usually best to first open an issue to discuss the changes, or discuss your intended approach for solving the problem in the comments for an existing issue. | ||
| We welcome feature requests! While we consider all suggestions, acceptance is not guaranteed. To avoid feature creep, please follow these guidelines: | ||
|
|
||
| For most contributions, after your first pull request is accepted and merged, you will be [invited to the project](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository) and given **push access**. :tada: | ||
| ### Guidelines: | ||
|
|
||
| - **Smaller is better.** Submit **one** pull request per bug fix or feature. A pull request should contain isolated changes pertaining to a single bug fix or feature implementation. **Do not** refactor or reformat code that is unrelated to your change. It is better to **submit many small pull requests** rather than a single large one. Enormous pull requests will take enormous amounts of time to review, or may be rejected altogether. | ||
| 1. Check for existing feature requests before submitting a new one. | ||
| 2. Fully complete the provided feature request template, providing comprehensive information. | ||
| 3. Be precise about the proposed outcome and its relation to existing features. | ||
| 4. Include implementation details if possible. | ||
|
|
||
| - **Coordinate bigger changes.** For large and non-trivial changes, open an issue to discuss a strategy with the maintainers. Otherwise, you risk doing a lot of work for nothing! | ||
| --- | ||
|
|
||
| - **Prioritize understanding over cleverness.** Write code clearly and concisely. Remember that source code usually gets written once and read often. Ensure the code is clear to the reader. The purpose and logic should be obvious to a reasonably skilled developer, otherwise you should add a comment that explains it. | ||
| ## :mag: Triaging Issues | ||
|
|
||
| - **Follow existing coding style and conventions.** Keep your code consistent with the style, formatting, and conventions in the rest of the code base. When possible, these will be enforced with a linter. Consistency makes it easier to review and modify in the future. | ||
| Contributors can assist in triaging issues, such as reproducing bug reports or requesting additional information. Any help in quickly resolving issues is highly appreciated. | ||
|
|
||
| - **Update the example project** if one exists to exercise any new functionality you have added. | ||
| --- | ||
|
|
||
| - **Use the repo's default branch.** Branch from and [submit your pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to the repo's default branch. Usually this is `main`, but it could be `dev`, `develop`, or `master`. | ||
| ## :repeat: Submitting Pull Requests | ||
|
|
||
| - **[Resolve any merge conflicts](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)** that occur. | ||
| We love pull requests! Before creating a pull request, it's advisable to open an issue to discuss changes or outline your intended approach. Please adhere to the following guidelines for a seamless contribution process: | ||
|
|
||
| - **Promptly address any CI failures**. If your pull request fails to build or pass tests, please push another commit to fix it. | ||
| ### Guidelines: | ||
|
|
||
| - When writing comments, use properly constructed sentences, including punctuation. | ||
| 1. Submit one pull request per bug fix or feature to keep changes isolated. | ||
| 2. For larger changes, discuss strategies with maintainers by opening an issue. | ||
| 3. Prioritize code clarity over complexity and follow existing coding styles and conventions. | ||
| 4. Update the example project if applicable to demonstrate new functionality. | ||
| 5. Use the default branch for your pull request and resolve any merge conflicts. | ||
| 6. Promptly address any CI failures. | ||
|
|
||
| - Use spaces, not tabs. | ||
| --- | ||
|
|
||
| ## :memo: Writing Commit Messages | ||
|
|
||
| Please [write a great commit message](https://chris.beams.io/posts/git-commit/). | ||
| Crafting meaningful commit messages is crucial. Follow these guidelines to ensure clear communication: | ||
|
|
||
| 1. Separate subject from body with a blank line | ||
| 1. Limit the subject line to 50 characters | ||
| 1. Capitalize the subject line | ||
| 1. Do not end the subject line with a period | ||
| 1. Use the imperative mood in the subject line (example: "Fix networking issue") | ||
| 1. Wrap the body at about 72 characters | ||
| 1. Use the body to explain **why**, *not what and how* (the code shows that!) | ||
| 1. If applicable, prefix the title with the relevant component name. (examples: "[Docs] Fix typo", "[Profile] Fix missing avatar") | ||
| ### Guidelines: | ||
|
|
||
| ``` | ||
| [TAG] Short summary of changes in 50 chars or less | ||
| 1. Separate subject from body with a blank line. | ||
| 2. Limit the subject line to 50 characters and use the imperative mood. | ||
| 3. Use the body to explain why, not what and how. | ||
| 4. Wrap the body at about 72 characters. | ||
| 5. If applicable, prefix the title with the relevant component name. | ||
|
|
||
| Add a more detailed explanation here, if necessary. Possibly give | ||
| some background about the issue being fixed, etc. The body of the | ||
| commit message can be several paragraphs. Further paragraphs come | ||
| after blank lines and please do proper word-wrap. | ||
| Wrap it to about 72 characters or so. In some contexts, | ||
| the first line is treated as the subject of the commit and the | ||
| rest of the text as the body. The blank line separating the summary | ||
| from the body is critical (unless you omit the body entirely); | ||
| various tools like `log`, `shortlog` and `rebase` can get confused | ||
| if you run the two together. | ||
| Explain the problem that this commit is solving. Focus on why you | ||
| are making this change as opposed to how or what. The code explains | ||
| how or what. Reviewers and your future self can read the patch, | ||
| but might not understand why a particular solution was implemented. | ||
| Are there side effects or other unintuitive consequences of this | ||
| change? Here's the place to explain them. | ||
| - Bullet points are okay, too | ||
| - A hyphen or asterisk should be used for the bullet, preceded | ||
| by a single space, with blank lines in between | ||
| Note the fixed or relevant GitHub issues at the end: | ||
| Resolves: #123 | ||
| See also: #456, #789 | ||
| ``` | ||
| --- | ||
|
|
||
| ## :white_check_mark: Code Review | ||
|
|
||
| - **Review the code, not the author.** Look for and suggest improvements without disparaging or insulting the author. Provide actionable feedback and explain your reasoning. | ||
| Effective code reviews are essential. Provide constructive feedback without criticizing the author personally. Remember: | ||
|
|
||
| - **You are not your code.** When your code is critiqued, questioned, or constructively criticized, remember that you are not your code. Do not take code review personally. | ||
| ### Guidelines: | ||
|
|
||
| - **Always do your best.** No one writes bugs on purpose. Do your best, and learn from your mistakes. | ||
| 1. Review the code, not the author. | ||
| 2. Understand that you are not your code. | ||
| 3. Always strive to do your best and learn from mistakes. | ||
| 4. Note any violations of guidelines specified in this document. | ||
|
|
||
| - Kindly note any violations to the guidelines specified in this document. | ||
| --- | ||
|
|
||
| ## :nail_care: Coding Style | ||
|
|
||
| Consistency is the most important. Following the existing style, formatting, and naming conventions of the file you are modifying and of the overall project. Failure to do so will result in a prolonged review process that has to focus on updating the superficial aspects of your code, rather than improving its functionality and performance. | ||
|
|
||
| For example, if all private properties are prefixed with an underscore `_`, then new ones you add should be prefixed in the same way. Or, if methods are named using camelcase, like `thisIsMyNewMethod`, then do not diverge from that by writing `this_is_my_new_method`. You get the idea. If in doubt, please ask or search the codebase for something similar. | ||
| Consistency is key. Follow existing styles, formatting, and naming conventions of the project. Failure to do so may result in a prolonged review process. | ||
|
|
||
| When possible, style and format will be enforced with a linter. | ||
| ### Guidelines: | ||
|
|
||
| ## :medal_sports: Certificate of Origin | ||
| 1. Maintain consistency with the existing codebase. | ||
| 2. Follow style and format conventions, enforced by a linter when possible. | ||
|
|
||
| *Developer's Certificate of Origin 1.1* | ||
| --- | ||
|
|
||
| By making a contribution to this project, I certify that: | ||
| ## :medal_sports: Certificate of Origin | ||
|
|
||
| > 1. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or | ||
| > 1. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or | ||
| > 1. The contribution was provided directly to me by some other person who certified (1), (2) or (3) and I have not modified it. | ||
| > 1. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. | ||
| Before contributing, certify that your contribution meets certain criteria outlined in the Developer's Certificate of Origin 1.1. | ||
|
|
||
| ## [No Brown M&M's](https://en.wikipedia.org/wiki/Van_Halen#Contract_riders) | ||
| --- | ||
|
|
||
| # Conclusion | ||
|
|
||
| 1) You can work on the non assigned issues once it is assigned to you or you can raise issue and get it assigned. | ||
| 2) Try to make proper changes in code without bug. | ||
| 3) Refactor and enhancement will be appreciated. | ||
| 4) Raise PR and tag @anand-harsh for review. | ||
| 5) Make PR directly on master branch of Edumi. | ||
| Thank you for considering contributing to our project! Here's a summary of the contribution process: | ||
|
|
||
| If you are reading this, bravo dear user and (hopefully) contributor for making it this far! You are awesome. :100: | ||
| 1. Work on non-assigned issues once assigned or raise an issue to get it assigned. | ||
| 2. Make changes in the code without introducing bugs. | ||
| 3. Refactor and enhancements are appreciated. | ||
| 4. Raise a PR and tag @anand-harsh for review. | ||
| 5. Make PR directly on the master branch of Edumi. | ||
|
|
||
| If you're reading this, congratulations on being an awesome contributor! Your efforts are truly appreciated. :100: |