Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

69 lines (42 loc) · 2.27 KB

Contributing

We are open to, and grateful for, any contributions made by the community. By contributing to Angular Redux, you agree to abide by the code of conduct.

Please review the Redux Style Guide in the Redux docs to keep track of our best practices.

Reporting Issues and Asking Questions

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Please ask any general and implementation specific questions on Stack Overflow with a Redux tag for support.

Development

Visit the Issue tracker to find a list of open issues that need attention.

Fork, then clone the repo:

git clone https://github.com/your-username/angular-redux.git

This repository uses Yarn v4 to manage packages. You'll need to have Yarn v1.22 installed globally on your system first, as Yarn v4 depends on that being available first. Install dependencies with:

yarn install

Building

Running the build task will create an ESM build.

yarn build

Testing and Linting

To run the tests:

yarn test

New Features

Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.

Submitting Changes

  • Open a new issue in the Issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the main branch.
  • Make sure all tests pass and there are no linting errors.
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing!

Cutting a release

If you are a maintainer and want to cut a release, follow these steps:

  • yarn build
  • cd dist && angular-redux
  • npm publish