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.
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.
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
Running the build task will create an ESM build.
yarn build
To run the tests:
yarn test
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.
- Open a new issue in the Issue tracker.
- Fork the repo.
- Create a new feature branch based off the
mainbranch. - 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!
If you are a maintainer and want to cut a release, follow these steps:
yarn buildcd dist && cd angular-reduxnpm publish