Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.1 KB

Contributing to Exilence Next

We appreciate any help in the project we can get. Before doing so, however, we have some guidelines we'd like for you to follow:

Submission Guidelines

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission before creating a new one.

  2. Be sure that an issue describes the problem you're fixing.

  3. Fork the viktorgullmark/exilence-next repo.

  4. Make your changes in a new git branch:

    git checkout -b my-fix-branch master
  5. Commit your changes using a descriptive commit message.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  6. Push your branch to GitHub:

    git push origin my-fix-branch
  7. In GitHub, send a pull request to exilence-next:master.

Coding Guidelines

  1. In general, we follow AirBnbs styleguides whenever applicable.

  2. Always use Material UI components whenever possible.

  3. Type everything (no exceptions). We will not accept pull requests with an object declared as any.

  4. Translate everything. We use react-i18next for translating, keys should be added in suiting namespace in /public/i18n. If a suiting namespace does not exist, feel free to create one (needs to be included in the config).

Required extensions

For contributions to the client, you should have the following extensions installed in VS code:

  1. Prettier - Code formatter

  2. ESLint