Emacs config utilizing prelude as a base
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

32 lines
1.4 KiB

  1. # Contributing
  2. If you discover issues, have ideas for improvements or new features, or
  3. want to contribute a new module, please report them to the
  4. [issue tracker][1] of the repository or submit a pull request. Please,
  5. try to follow these guidelines when you do so.
  6. ## Issue reporting
  7. * Check that the [issue has not already been reported][5].
  8. * Check that the issue has not already been fixed in the latest code
  9. (a.k.a. `master`).
  10. * Be clear, concise and precise in your description of the problem.
  11. * Open an issue with a descriptive title and a summary in grammatically correct,
  12. complete sentences.
  13. * Include any relevant code to the issue summary.
  14. ## Pull requests
  15. * Read [how to properly contribute to open source projects on Github][2].
  16. * Use a topic branch to easily amend a pull request later, if necessary.
  17. * Write [good commit messages][3].
  18. * Use the same coding conventions as the rest of the project.
  19. * Verify your Emacs Lisp code with `checkdoc` (<kbd>C-c ? d</kbd>).
  20. * Open a [pull request][4] that relates to *only* one subject with a clear title
  21. and description in grammatically correct, complete sentences.
  22. [1]: https://github.com/bbatsov/prelude/issues
  23. [2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
  24. [3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
  25. [4]: https://help.github.com/articles/using-pull-requests
  26. [5]: https://github.com/bbatsov/prelude/issues?q=is:issue