Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

76 lines (58 loc) · 3.04 KB
Raw

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.

Use Ruby and Markdownlint to check your changes:

gem install mdl rake
rake test

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

The Project Board

If you are looking for issues to work on, the project board is the place to go. Usually, you look at the issues from right to left, as the ones in the rightmost part are the closer to get merged and have higher priority.

If you just want to dive in and start writing, the backlog has the 'ready to be picked up' issues. These issues have been discussed already and are most likely just waiting for someone to make a PR. Just look for the issues with the enhancement and/or help wanted labels.

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.

Translations

If you would like to help translate the Style Guide, check if there is an existing translation to contribute to. To create a new translation:

  1. Fork this repository.
  2. Clone your fork locally.
  3. Copy README.md to a new file named after the country/language, like README-jaJP.md, and commit your translations there.
  4. Add the main repo as an upstream remote, to fetch and merge changes.