Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

28 lines (23 loc) · 1.44 KB

Contributing

Thanks for your interest in react-images. All forms of contribution are welcome, from issue reports to PRs and documentation / write-ups.

Before you open a PR:

  • If you're planning to add or change a major feature in a PR, please ensure the change is aligned with the project roadmap by opening an issue first, especially if you're going to spend a lot of time on it.

  • In development, run npm start to build (+watch) the project source, and run the development server.

  • Please ensure all the examples work correctly after your change. If you're adding a major new use-case, add a new example demonstrating its use.

  • Please do not commit the build files. Make sure only your changes to /src/ and /examples/src are included in your PR.

  • Be careful to follow the code style of the project. Run npm run lint after your changes and ensure you do not introduce any new errors or warnings.

  • Please follow established coding conventions (with regards to formatting, etc)

  • You can also run npm run lint and npm run style - our linter is a WIP but please ensure there are not more violations than before your changes.

  • All new features and changes need documentation.

  • Make sure you revert your build before submitting a PR to reduce the change of conflicts. gulp build-scripts is run after PRs are merged and before any releases are made.