Skip to content

contributing.md

Latest commit

 

History

History
75 lines (51 loc) · 2.28 KB

contributing.md

File metadata and controls

75 lines (51 loc) · 2.28 KB

Contributing

We are open to any contributions made by the community. Here’s how you can help us while developping on react-include.

Reporting issues

Don’t forget to search the issue tracker before opening up an issue.

Bugs and improvement

We use the issue tracker to keep track of bugs and improvements, including the source code, the tests and the documentation. We encourage you to open issues to discuss bugs and improvements before creating a pull request. Other contributors might work on the same subject at the same time which would lead to duplicate work.

Getting help

If you cannot achieve what you want using react-include, we encourage you to provide a minimal, complete and verifiable example in the form of a public repository. Don’t forget to include a package.json file describing your dependencies.

Development

Once you’ve found a bug or an improvement worth working on and you’ve expressed your interest in working on it, fork then clone the repository.

git clone git@github.com:rednetio/react-include.git

Code style

Code style is checked using ESLint and Prettier. General guidelines:

  • lines are limited to 80 characters,
  • use camelCase for identifiers,
  • use single quotes,
  • use yoda conditions wherever you can.

You can use yarn lint or npm run lint to check code style.

Testing

We strive for 100% coverage. We use Mocha and Istanbul for testing and coverage. Additionally, we import Chai’s expect and Sinon at a global level in tests. Enzyme and JSDOM are used to test the components.

Use yarn test or npm test to run tests, and yarn coverage or npm run coverage to see code coverage.

Open a pull request

Once your bug fix or improvement is ready, open a pull request against master and we will review it as soon as possible.

Thank you for contributing!