cucumber-forge-report-generator/CONTRIBUTING.md

NPM Library for Generating Static Cucumber Reports

# Contributing

Help us to make this project better by contributing. Whether it's new features, bug fixes, or simply improving documentation, your contributions are welcome. Please start with logging a [github issue][1] or submit a pull request.

Before you contribute, please read our [code of conduct][9] and review these guidelines to help ensure a smooth process for everyone.

Thanks.

## Issue Reporting

* Please browse our [existing issues][1] before logging new issues.
* Check that the issue has not already been fixed in the `main` branch.
* Open an issue with a descriptive title and a summary.
* Please be as clear and explicit as you can in your description of the problem.
* Please state the version of NPM, Node.Js, and cucumber-forge-report-generator you are using in the description.
* Include any relevant code in the issue summary.

## Pull Requests

* Read [how to properly contribute to open source projects on Github][2].
* Fork the project.
* Use a feature branch.
* Write [good commit messages][3].
* Use the same coding conventions as the rest of the project.
* Commit locally and push to your fork until you are happy with your contribution.
* Make sure to add tests and verify all the tests are passing when merging upstream.
* Add an entry to the [Changelog][4] accordingly.
* Please add your name to the [CONTRIBUTORS.md][8] file. Adding your name to the [CONTRIBUTORS.md][8] file signifies agreement to all rights and reservations provided by the [License][5].
* [Squash related commits together][6].
* Ensure project linting checks pass using `npm run lint`.
* Open a [pull request][7].
* The pull request will be reviewed by the community and merged by the project committers.

[1]: https://github.com/cerner/cucumber-forge-report-generator/issues
[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[4]: ./CHANGELOG.md
[5]: ./LICENSE
[6]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
[7]: https://help.github.com/articles/using-pull-requests
[8]: ./CONTRIBUTORS.md
[9]: ./CODE_OF_CONDUCT.md