Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 5.33 KB

CONTRIBUTING.md

File metadata and controls

107 lines (71 loc) · 5.33 KB
Raw

Contributing

Dependency Status Build Status Coverage Status

It is imperative that pull requests include tests and documentation and issues follow guidelines.

Please be familiar with the GitHub Community Guidelines before contributing to this project. If you are new to open source, check out this 38 minute course on how to contribute to open source on GitHub. It's free! 😄

Getting Started

  1. Clone the repository
  2. Install dependencies: npm install, or, if you use Yarn: yarn
  3. Run tests: npm test
  4. Run example: npm start

Need Help? 🙋

It's okay to ask for help via a GitHub issue, but first read the "Filing an Issue" guide and consider:

  • Is my issue specific to this project?
  • Is StackOverflow a better place to ask for help? If yes, use the #redux tags.
  • Can I reduce the code example to the bare minimum required to explain what I need help with?
  • Can I create a JSBin for the code example?
  • Can I explain what the expected behavior is?
  • Can I explain what the actual behavior is?

Upgrading Dependencies

Use Yarn instead of npm to upgrade dependencies.

You can interactively upgrade dependencies:

yarn upgrade-intractive

Or you can upgrade dependencies one by one. For example, to upgrade Redux, you would run a command like this:

yarn add redux@4.0.0 -D

Install synp:

npm install -g synp

Sync package-lock.json with yark.lock by running:

yarn generate-lockfile

Found a Bug?

The best bug report is a failing test in the repository as a pull request. Please refer to the "Filing an Issue" guide and include:

  • Version number
  • Steps to reproduce
  • Expected behavior
  • Actual behavior

Have a Feature Request?

If you have a feature request, provide commentary and code samples on what this feature means for you.

  • What do you perceive it will enable you to do?
  • What potential bugs will be avoided?
  • What edge cases will it support?
  • Is it a micro-optimization. If yes, is it a valuable?

Please refer to the "Filing an Issue" guide.

Filing an Issue

  1. Check if a related open issue exists by using search. See the GitHub guide to searching issues.
  2. If a related issue does not exist, open an issue.
  3. If a related issue does exist, contribute to the conversation there.

Before you create an issue, consider:

  • Did you describe the problem you are encountering?
  • Did you describe the expected behavior?
  • Did you provide a formatted code example? See the GitHub guide on how to format code with Markdown.
  • Did you include a relevant label?

If you include all of the above, it is easier to understand you. We respond quicker to formatted, comprehensive issues.

Please keep in mind that issues should contribute to the community. The primary function of issues should be for bugs and feature requests. If you open an issue asking for help, that's fine. However, if you do not provide context or code examples, the issue will be closed and you will be redirected to this document.

Making a Contribution

  1. Check the issues for "help wanted" labels.
  2. Check if there is a pull request already open for this issue. If there is, please do not duplicate efforts.
  3. Commit the changes required to resolve the issue. Git commit messages should be written in the imperative. A pre-commit hook will run tests and lint code. If needed, you can force a commit with --no-verify.
  4. If needed, add one or more unit test(s). For new features and bug fixes, a unit test is required. Follow the red/green/refactor process.
  5. Run tests and linter: npm test. Code is linted using ES Lint. Rules are located in .eslintrc. You must maintain the existing code style. Tests must pass before the PR is merged.
  6. Document new features and/or API changes.

If you add a new dependency (for the package or development), you will need to use Yarn to update the yarn.lock file with the dependency version. By installing depdencies faster than npm, Yarn drastically decreases the time it takes to run builds on continuous integration.

File organization

All code, including tests, is written in next-generation JavaScript and transpiled using Babel. Source files are located in src and transpiled to dist, which is gitignored. Tests should be placed in a test directory.