Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 4.18 KB

contributing.md

File metadata and controls

79 lines (58 loc) · 4.18 KB
Raw

Contribution Guide

Be nice and respect the maintainers' time. ❤️

Please read this whole thing. Most of this applies to any repo on GitHub. 🙏

Contribute

Code is not the only thing you can contribute. I truly appreciate contributions in the form of:

  • Fixing typos.
  • Improving docs.
  • Triaging issues.
  • Reviewing pull requests.
  • Sharing your opinion on issues.

Issues

  • Before opening a new issue, look for existing issues (even closed ones).
  • Don't needlessly bump issues.
  • If you're reporting a bug, include as much information as possible. Ideally, include a test case that reproduces the bug. For example, a Runkit or repl.it playground. Even better, submit a pull request with a failing test.

Pull requests

Prerequisite

  • If the changes are large or breaking, open an issue discussing it first.
  • Don't open a pull request if you don't plan to see it through. Maintainers waste a lot of time giving feedback on pull requests that eventually go stale.
  • Don't do unrelated changes.
  • Adhere to the existing code style.
  • If relevant, add tests, check for typos, and add docs and types.
  • Don't add editor-specific metafiles. Those should be added to your own global gitignore.
  • Don't be sloppy. I expect you to do your best.
  • Squash your local commits into one commit before submitting the pull request, unless you have important atomic commits.
  • Double-check your contribution by going over the diff of your changes before submitting a pull request. It's a good way to catch bugs/typos and find ways to improve the code.
  • Do the pull request from a new branch. Never the default branch (main/master).

Submission

  • Give the pull request a clear title and description. It's up to you to convince the maintainers why your changes should be merged.
  • If the pull request fixes an issue, reference it in the pull request description using the syntax Fixes #123.
  • Make sure the “Allow edits from maintainers” checkbox is checked. That way I can make certain minor changes myself, allowing your pull request to be merged sooner.

Review

  • Push new commits when doing changes to the pull request. Don't squash as it makes it hard to see what changed since the last review. I will squash when merging.
  • It's better to present solutions than asking questions.
  • Review the pull request diff after each new commit. It's better that you catch mistakes early than the maintainers pointing it out and having to go back and forth.
  • Be patient. Maintainers often have a lot of pull requests to review. Feel free to bump the pull request if you haven't received a reply in a couple of weeks.
  • And most importantly, have fun! 👌🎉

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

 (a) 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

 (b) 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

 (c) The contribution was provided directly to me by some other
     person who certified (a), (b) or (c) and I have not modified
     it.

 (d) 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.