Thank you for helping out with the HubSpot CMS Boilerplate! We are always looking for people to help contribute to and improve upon the project and there are plenty of ways that you can get involved. Please take a moment to review this document so that the contribution process is easy and effective for everyone involved.
The issue tracker is the preferred channel for reporting bugs, and making features requests but please be sure to follow the following guidelines:
- For questions specific to your individual project, and how to build something, reach out in the community developer forums or HubSpot Developer Slack.
- If you experience issues with your HubSpot account itself, such as features not working as expected, reach out to HubSpot support.
- Please be respectful and constructive with any and all feedback, we all want to build a better experience together.
- Please open issues for third party tools in their respective repositories (e.g. prettier and eslint).
A bug is a reproducible issue that is caused by the code in the HubSpot CMS Boilerplate. If you find a bug while using the HubSpot CMS Boilerplate for your projects, please let us know! Any bugs that are not specifically related to the HubSpot CMS Boilerplate and are more related to the HubSpot product should be filed to our support team. More information on contacting our support team can be found here.
Guidelines for a bug report:
- Search through open GitHub issues to see if there is already an open issue.
- Check to see if the issue has been fixed in a recent pull request and ensure that you’re using the latest version of the main branch when testing.
- Isolate the problem and create a list of reproducible steps.
- A good bug report should include all information needed for someone to resolve the issue. Please try to be as detailed as possible. Providing more detail will make it easier to identify the issue and resolve the issue faster.
A feature request is a request for a new feature that currently doesn't exist within the project. While we welcome feature requests, please take some time to determine how the feature request fits into the existing project. We'll need to understand why the feature is important and what it is solving. Any feature requests that are not specifically related to the HubSpot CMS Boilerplate and are more related to the HubSpot product should be submitted to our ideas forum here or in the #ideas channel in our public developer Slack channel.
Guidelines for a feature request:
- Search through open GitHub issues to see if there is already an open issue related to the feature request.
- Check to see if the feature request has been implemented in a recent pull request and ensure that you’re using the latest version of the main branch when testing.
Pull requests for bug fixes, enhancements, and new features are great ways to help contribute to the HubSpot CMS Boilerplate. You can and should expect some back-and-forth with stakeholders when you open a pull request. Please check in frequently to address any requests for changes so that your code can successfully be merged.
Guidelines for pull requests:
- Changes made in pull requests should have a focused scope and you should avoid containing unrelated commits to the change that is being made.
- Please reach out before working on a significantly large pull request otherwise you may risk spending a lot of time on something that may not end up being merged into the HubSpot CMS Boilerplate. We’d recommend creating an issue using the label of
ideaprior to working on a large update to the project. - Please ensure that your changes follow our style guide requirements to ensure that all code remains consistent and easy to read.
We recommend forking the project and submitting your changes using the pull request template.