First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions 🎉
And if you like the project, but just don't have time to contribute, that's okay! There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
- ⭐️ Star the project
- 👨💻 Tweet about it and tag our Twitter handle (@caishcloud)
- 🔗 Refer this project in your project's README
This project and everyone participating in it is governed by the react-cookies-consent Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
If you want to ask a question, we assume that you have read the available Documentation.
Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue
- Provide as much context as you can about the problem you're running into
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
We will then take care of the issue as soon as possible!
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content, and the content you contribute may be provided under the project license.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information, and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version
- Determine if your bug is really a bug and not an error on your side. If you are looking for support, you might want to check this section.
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
- Also make sure to search the Internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform, and Version
- Versions of any packages or libraries being used
- Screenshots of the components you implemented (such as the Alert or Modal components) and all the configurations you made to them
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
You must never report security related issues, vulnerabilities, or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to [email protected].
We use GitHub Issues to track bugs and errors. If you run into an issue with the project:
- Open a Bug Report
- Explain the behavior you would expect and the actual behavior
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports, you should isolate the problem, and create a reduced test case.
- Provide the information you collected in the previous section
Once it's submitted:
- The project team will label the issue accordingly
- A team member will try to reproduce the issue with your provided steps. If
there are no reproduction steps or no obvious way to reproduce the issue, the
team will ask you for those steps and mark the issue as
needs-repro. Bugs with theneeds-reprotag will not be addressed until they are reproduced. - If the team is able to reproduce the issue, it will be marked
needs-fix, as well as possibly other tags (such ascritical), and the issue will be left to be implemented by someone.
This section guides you through submitting an enhancement suggestion for react-cookies-consent, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
- Make sure that you are using the latest version
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration
- Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
Enhancement suggestions are tracked as GitHub Issues.
- Use a clear and descriptive title for the issue to identify the suggestion
- Provide a step-by-step description of the suggested enhancement in as many details as possible
- Describe the current behavior and explain which behavior you expected to see instead and why. At this point, you can also tell which alternatives do not work for you.
- You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most react-cookies-consent users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
To get started with your code contribution, we recommend setting up a brand new React project with Vite, and then including the forked project as a import. We will walk through the steps below to do this.
npx create-vite update-react-cookies-consent --template react- Add this to the
index.css:
html {
height: 100%;
width: 100%;
}npm start- Click the link that displays in the console to open the web app in your browser
- Fork this repo
cdinto the project directoryyarn- Create your feature branch:
git checkout -b my-new-feature - Make your changes
yarn build- Import this project into your previously created React project's
App.js:This assumes that both of these projects live in the same folder. You may need to update the path below if the assumption is incorrect.
import {
CookiesConsentAlert,
CookiesConsentModal
} from '../../react-cookies-consent/dist';- Add the component(s) based on how it is shown in the documentation usage examples
- Repeat step 6 every time you make a change to react-cookies-consent to see it update in your browser
- Add your changes:
git add . - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request 😎
- Fork this repo
- Create your feature branch:
git checkout -b my-new-feature - Update the
README.mdwith your suggested improvements or fixes - Add your changes:
git add . - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request 😎
This guide is based on the contributing-gen. Make your own!