Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 979 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 979 Bytes
Raw

Contributing to the Aeternity node

Pull Requests

  • Squash your commits to ensure each resulting commit is stable and can be tested.
  • Include issue numbers in the PR title, e.g. "GH-128. Resolves issue #123".
  • Follow the Erlang mode for Emacs indentation, e.g. provided by EDTS.
  • Add unit tests for self-contained modules.
  • Add integration tests as needed.
  • Document new code.
  • End all files with a newline

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Learn more about writing a good commit message.