Thank you for taking the time and consideration to contribute to Siren.js!
This document outlines our guidelines for contributing to this repository, which is part of the Siren.js project. Following these guidelines helps communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. Check out the Code of Conduct to learn about our core values and norms.
If you have feedback or questions, your contribution has been sitting for a while, you need help, or would like to talk through a contribution, feel free to join the Google Group!
First time contributing to open source? You can learn how from this free video series: How to Contribute to an Open Source Project on GitHub.
If you find a bug or would like to request a new feature, be sure to check out the current list of issues. If you can't find anything, feel free to create a new one.
If you'd like to contribute a change, follow these steps:
- Fork the repository.
- Clone your fork.
- Create a branch.
- Make and commit your changes (see Development).
- If you're making code changes, be sure to write tests!
- Push your changes to your fork.
- If your build is passing, create a pull request.
- Wait for a review and make changes as requested.
- Get merged!
This section helps you get your development environment set up for making code changes.
First, be sure you have Angular 11 set up locally. Next, cd into the
directory of your cloned fork and run npm install. And that's it, you're ready
to start coding!
This project uses SemVer. When making code changes, be
sure to increment the version accordingly with the
npm version command. We recommend using the
--no-git-tag-version option to avoid potential issues.