Skip to content

Latest commit

 

History

History
101 lines (75 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

101 lines (75 loc) · 3.46 KB

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

This section helps you get your development environment set up for making code changes.

First, you'll want to be sure Node.js is installed. You can either download and install it directly from Node's website, or you can use a Node version manager (recommended for testing on multiple versions of Node). There's nvm for Mac/Linux and nvm-windows for Windows.

Next, cd into the directory of your cloned fork and run npm install.

Now you're ready to start coding! All code lives in the src directory, and tests for a module live in the __test__ directory next to it. Here are some example commands you can run at the root of the project:

# format files with Prettier
$ npm run format

# lint with ESLint
$ npm run lint
# automatically fix lint issues where possible
$ npm run lint:fix

# test with Jest
# run tests in Node
$ npm run test:node
# run tests in the browser
$ npm run test:jsdom
# run tests in both environments
$ npm test
# run tests as you make changes
$ npm run test:node -- --watch

# compile TypeScript
$ npm run compile

# build (compile, lint, test) the project
$ npm run build

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.