Skip to content

Latest commit

 

History

History
98 lines (54 loc) · 5.97 KB

CONTRIBUTING.md

File metadata and controls

98 lines (54 loc) · 5.97 KB

Contributing Guidelines

Contributions are welcomed and highly encouraged! :octocat:

Contents

📥 Opening an Issue

Before creating an issue, check if you are using the latest version of the project. If you are not up-to-date, see if updating fixes your issue first.

🔒 Reporting Security Issues

Do not file a public issue for security vulnerabilities. Reach out to me @anirbanpranto via email or other core maintainers for any security issue.

🪲 Bug Reports and Other Issues

In short, since you are most likely a developer -

  • Review the documentation before opening an issue.

  • Do not open a duplicate issue! Search through existing issues to see if your issue has previously been reported. If your issue exists, comment with any additional information you have.

  • Use GitHub-flavored Markdown. Especially put code blocks and console outputs in backticks (```). This improves readability.

💌 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. Your idea may be great, but also out-of-scope for the project.

  • Do not open a duplicate feature request. Search for existing feature requests first.

  • Be precise about the proposed outcome of the feature and how it relates to existing features. Include implementation details if possible.

🔁 Submitting Pull Requests

Before forking the repo and creating a pull request 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.

Note: All contributions will be licensed under the project's license.

  • 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.

  • 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.

  • 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.

  • Add documentation. Document your changes with code doc comments or in existing guides.

  • Update the CHANGELOG for all enhancements and bug fixes. Include the corresponding issue number if one exists, and your GitHub username. (example: "- Fixed crash in profile view. #123 @anirbanpranto")

  • Use the repo's default branch. Branch from and submit your pull request to the repo's default branch. Usually this is master, but it could be dev or staging as well.

  • Resolve any merge conflicts that occur.

  • Promptly address any CI failures. If your pull request fails to build or pass tests, please push another commit to fix it.

  • When writing comments, use properly constructed sentences, including punctuation.

📝 Writing Commit Messages

  1. Use one of these prefixes before every commit - fix, feat
  2. Tag the issue number at the start if applicable
[#tag]fix: fixes xyz bug

✅ 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.

  • 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.

  • Always do your best. No one writes bugs on purpose. Do your best, and learn from your mistakes.

  • Kindly note any violations to the guidelines specified in this document.

💅 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.

When possible, style and format will be enforced with a linter.

🙏 Credits

Part of this doc is taken from @jessesquires.

Please feel free to adopt this guide in your own projects. Fork it wholesale or remix it for your needs.