Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 1.83 KB

Contributing to the Elixir Style Guide

First of all, thanks for wanting to contribute! ❤️

You can contribute in several ways:

  • open up an issue if you find something plain old wrong in the style guide (e.g., typos or formatting);
  • open up an issue if you find inconsistencies in the style guide. This way, we can discuss the better way to eliminate those inconsistencies;
  • if you have any suggestions or opinions, open up an issue or (even better!) a pull request.

If you edit the README.md file, please stick to this set of formatting/markup/style rules so that the style remains consistent:

  • don't make lines longer than 80 characters (most editors have an auto-wrapping functionality, for example Emacs or Vim);
  • use reference-style links, like [an example][Example]. Put the links in alphabetical order at the end of the document, and capitalize the first word of the link label.

Install Markdownlint to check your changes, and run:

mdl --style 'markdown.rb' README.md

IMPORTANT: By submitting a patch, you agree that your work will be licensed under the license used by the project.

Collaborators

If you have contributed to the repository you can be appointed as a collaborator after submitting a change and getting it merged. Collaborators are invited to manage issues, make corrections to the style guide, review pull requests, and merge approved changes.

  1. All changes must pass automatic checks before being merged.
  2. Minor changes and corrections can be merged without review.
  3. Significant changes or new style rules should be discussed and approved in a pull request.