Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

79 lines (57 loc) · 3.2 KB
Raw

Contribution Guidelines

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.

Bugs and Feature Requests

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.

Pull Requests

If you'd like to contribute a change, follow these steps:

  1. Fork the repository.
  2. Clone your fork.
  3. Create a branch.
  4. Make and commit your changes (see Development).
    • Be sure to update the changelog.
    • If you're making code changes, be sure to write tests!
  5. Push your changes to your fork.
  6. If your build is passing, create a pull request.
  7. Wait for a review and make changes as requested.
  8. Get merged!

Development

Setup is simple. cd into the project directory and run npm install. Now you're ready to code!

In the project directory, you can run the following commands

  • npm start - Runs the app in the development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

  • npm test - Launches the test runner in the interactive watch mode. See the section about running tests for more information.

  • npm run build - Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

    The build is minified and the filenames include the hashes. Your app is ready to be deployed!

    See the section about deployment for more information.

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.