Thank you for investing your time in contributing to our project!
If you want to know what features are implemented in this package, please refer to the documentation under docs/usage.
See docs/development.md for development environment setup, testing, linting and benchmarking.
If there is a problem with the package, search to see if the issue already exists. If no related issue exists, you can open a new issue using one of the issue templates.
This package is intended to be as compatible as possible with the built-in containers, so different behavior or missing attributes or member functions are bugs. Feature request template is intended to be used as a template for requests for make the package more useful.
- Fork the repository
- Setup the development environment locally. See our development guide for more details.
- Create a working branch and start with your changes.
Commit your code changes when you are satisfied with them.
Although there are no explicit conventions for commit messages in our project,
it is more appreciated if they are written according to the following format: <type>(<scope>): <short summary> (See "Commit Message Header" in "Contributing to Angular" for possible <type> options)
When you have finished coding and have verified that the tests and lint pass, it's time to make a pull request (PR).
- Fill the PR template which will helps reviewers understand your changes.
- Don't forget to link PR to issue.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. We may ask questions or request for additional information.
- As you update your PR and apply changes, mark each conversation as resolved.
After the review is complete, your PR will be merged to the repository and we will thank you :)