Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

73 lines (54 loc) · 3.47 KB

Contributing to Rapid React 🎉

Contributions are always welcome. 🥳 Before contributing please read the code of conduct. To contribute, fork Rapid React, commit your changes, & send a pull request pointing to development branch. 🎈

$ git clone https://github.com/<your-github-username>/rapid-react
$ cd rapid-react
$ npm install

Ways to Contribute ❤️

  • Write a blog, share on LinkedIn, Tweet about the project.
  • Improve documentation.
  • Fix a bug.
  • Implement a new feature.
  • Discuss potential ways to improve project.
  • Improve existing implementation, performance, e.t.c.

Found a bug? Missing a specific feature? 📬

Feel free to raise a bug or a feature request. Please search the issue tracker beforehand, your issue/feature may have already been discussed or fixed in master.

File a bug 🪲

In case you've encountered a bug, please make sure:

  • You are using the latest version.
  • You have read the documentation first, and double-checked your configuration.
  • You have acknowledged from troubleshooting & debugging the errors are likely a bug in this project, and not coming from e.g. your environment or custom scripts/commands.
  • In your issue description, please include:
    • A clear and descriptive title.
    • A comprehensive description of the expected behavior & use case of an issue, in as much detail as possible.
    • Your operating system and other environment information.
    • All steps to reproduce the issue.

Raise a feature request 🎁

We would love to hear amazing features from you! ❤️ Please raise it in the issue tracker and make sure you provide:

  • A clear and descriptive title.
  • A comprehensive description of of the suggested enhancement, why you need it, how it should work.
  • As much detail and context as possible.

Coding Guidelines 💻

In addition to the following guidelines, please follow the conventions already established in the code.

  • Spacing:
    Use two spaces for indentation. No tabs.

  • Naming:
    Keep variable & method names concise & descriptive. Variable names index, array, are preferable to i, arr.

  • Quotes:
    Single-quoted strings are preferred to double-quoted strings; however, please use a double-quoted string if the value contains a single-quote character to avoid unnecessary escaping.

  • Comments:
    Please use descriptive comments to annotate significant additions.

  • Commit messages:
    Give extra care to your commit messages. Write short and descriptive messages with appropriate prefix such as:

    $ git commit -m "chore: added new eslint <name-of-rule> rule"
$ git commit -m "fix: folder scaffolding crash due to <condition>"
$ git commit -m "feature: <description-of-new-feature>"

Guidelines are enforced using ESLint:

$ npm run lint

Note: make sure to always keep README.md up to date with new features being added, existing functionalities being deprecated, e.t.c.