-
Notifications
You must be signed in to change notification settings - Fork 354
Top level files
The main files for the HubSpot CMS Boilerplate project can be found in the src folder. With that being said, there are several files outside of the src folder which are also used that may or may not be useful within your own projects.
This folder contains three separate pieces. The first is pre-built GitHub issue templates that can be found within the ISSUE_TEMPLATE subfolder. These issue templates make it easier to file consistent issues within a given repository. If you want to learn more about GitHub issue templates, please check out this article.
This folder also contains a pull request template. This is the default template that is used when creating a pull request within the repository. If you want to learn more about GitHub pull request templates, please check out this article.
Lastly, the folder contains files for the automatic deploy process between the HubSpot CMS Boilerplate GitHub repository and sample website. These files can be found under the workflows subfolder. The lint.yml file runs the eslint command from the scripts in package.json. The deploy.yml file deploys the code from the GitHub repository to the sample website using HubSpot's pre-built GitHub action. You can learn more about setting this up for you own project in this article.
The files listed above are all HubSpot specific files that we use to deliver the HubSpot CMS Boilerplate as a starting point in the design manager. These files can be safely removed from your own project.
The files listed above are markdown files which are used for the README on the main page of the GitHub repository as well as instructional files about how to contribute to the HubSpot CMS Boilerplate and what our style guide rules are.
The license for the HubSpot CMS Boilerplate project.
A list of files that are ignored when making a commit to the GitHub repository. To learn more about .gitignore files, please check out this article.
These are config files used for Prettier and ESLint that are used within the package.json file.
A file that has some useful content about the project along with some developer dependencies that can be used to make maintaining your project easier (e.g. Autoprefixer, ESLint, Prettier).