Skip to content

Latest commit

 

History

History
22 lines (17 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

22 lines (17 loc) · 1.47 KB
Raw

Contributing

When contributing to this repository, first consider opening an issue if you have any ideas or features you'd like to see implemented.

If you made your own additions to the project you'd like to see added to this main repository please create a pull request from you forked repository and properly descibe all of the changes.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Requests

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes, this includes new environment, variables and files.
  3. Do not make any changes to code styling enforced by the Eslint configurations.
  4. Make sure your code passes all tests (which should be changed appropriately according to your new changes)
  5. Project is being developed with TypeScript and any changes should be added according to the TypeScript config.
  6. Increase the version numbers in any examples files and the README.md to the venew version that this Pull Request would represent. The versioning scheme we use is SemVer.
  7. Your Pull Request should list the owner of this repository as the main reviewer, whose confirmation is required for request to be merged.