Skip to content

Latest commit

 

History

History
31 lines (28 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

31 lines (28 loc) · 1.69 KB

Contribution guidelines

The Wikimate project welcomes contributions of all kinds, no matter how small! Feel free to open an issue to discuss your suggestion or request, or submit your changes directly as a pull request if you prefer.

Below are some guidelines that might help you prepare your contribution.

  1. Limit pull requests limited to a single feature or bugfix. Unrelated changes should be sent as separate PRs. The exception are minor cleanup changes, which can be included (as a separate commit) in the PR that prompted them.
  2. Use atomic commits. Try to create commits that are as small as possible while still representing a self-contained set of changes, and use descriptive commit messages. We recommend these principles for writing great commit messages (but they're not enforced, so don't sweat it 🙂).
  3. Include a CHANGELOG.md entry in every pull request. This makes it much easier to prepare releases, and allows the author of each change to properly summarize it.
  4. Update the documentation in USAGE.md if necessary. When writing prose, break lines semantically. We don't have a strict maximum line length (especially since things like long URLs can easily surpass them), but you should start thinking about breaking lines once they're approaching 100 characters in length.