Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 2.26 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a Code of Conduct, please follow it in all your interactions with the project.

We release new versions of this project (maintenance/features) on a monthly cadence so please be aware that some items will not get released right away.

Testing Environment

To do testing you need to have redis installed on your machine. Have docker installed and run the following command to start a redis container:

pnpm test:services:start

Pull Request Process

You can contribute changes to this repo by opening a pull request:

  1. After forking this repository to your Git account, make the proposed changes on your forked branch.
  2. Run tests and linting locally by running pnpm i && pnpm test.
  3. Commit your changes and push them to your forked repository.
  4. Navigate to the main cacheable repository and select the Pull Requests tab.
  5. Click the New pull request button, then select the option "Compare across forks"
  6. Leave the base branch set to main. Set the compare branch to your forked branch, and open the pull request.
  7. Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
  8. Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
  9. Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the main repository branch and pushed via our release schedule.

If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the GitHub documentation

Code of Conduct

Please refer to our Code of Conduct readme for how to contribute to this open source project and work within the community.