Welcome to CookieConsent contributing guide

August 9, 2024 · View on GitHub

Thank you for investing your time in contributing to this project!

Documentation

Documentation is available in cookieconsent/docs.

Getting Started

Issues

If you encountered a problem, search if an issue already exists. If no related issues are found, you can open a new issue via the appropriate issue template.

Make Changes

Prerequisites
1. You need to have node.js LTS installed to test your changes and create the bundled version of the source code.
2. This project uses pnpm to manage the dependencies, which you can install via:
```
npm i -g pnpm
```
3. Follow the Getting started with GitHub Desktop guide.
Make changes locally
1. Fork and clone the repository.
2. Create a new working branch.
3. Go to the root of the repo and install all dependencies via:
```
pnpm install
```
4. Make the changes, to see your local changes in action, run:
```
pnpm dev
```
  Note: If you're making changes to the documentation, use pnpm docs:dev.
5. Once you've finished, generate the bundled version via:
```
pnpm build
```
6. Make sure tests are all green:
```
pnpm test
```
Push the changes and create a Pull Request.

Pull Request (PR)

When creating a new PR, explain briefly what it improves/fixes so that we can easily understand your changes.
Don't forget to link existing issues, if you're solving one.
Enable the allow maintainer edits checkbox so that the branch can be updated for a merge.
We may ask questions or require changes before a PR is merged.
If everything is clear and sorted out, your PR will be merged! Congratulations 🎉!

Before creating a feature requests, make sure you "are on the same page" as the maintainer, so that your efforts don't get rejected! A feature request might be rejected if there is no related issue/discussion.

Thanks!

Once your PR is merged, your contribution will be available in the next release!

Questions?

If you have any questions, feel free to open a new discussion!