Skip to content

Commit 462f88b

Browse files
chore: #250 update contributing docs for conventional commits (#271)
1 parent 4e9857c commit 462f88b

1 file changed

Lines changed: 17 additions & 34 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,27 @@ The layout of the project is as follows:
88

99
- _/assets/_ - Public assets like images and fonts used throughout the site
1010
- _/components/_ - Custom Element web components to be used throughout the project
11+
- _/layouts/_ - Page level layouts for various section of the website
1112
- _/pages/_ - File based routing as provided by Greenwood
12-
- _/stories/_ - General developer documentation about the project for developers
13+
- _/stories/_ - General documentation about the project for developers, hosted in Storybook
1314
- _/styles/_ - Global theme and styles
1415

1516
> [!NOTE]
1617
> Please review the documentation contained in this project's Storybook by running `npm run story:dev` and going through the content in the **Overview** section.
1718
18-
## Documentation Changes
19-
20-
### Greenwood Features
21-
22-
Documentation changes specific to an in progress / unreleased feature in Greenwood should be made to the corresponding feature branch in this repository aligning with that Greenwood release. This can be determined at the time of submitting your PR to Greenwood in coordination with the maintainers.
23-
24-
For example, if the next release your feature is targeting for Greenwood is 1.1.0, the git workflow would be as follows:
25-
26-
```sh
27-
$ git checkout release/1.1.0
28-
$ git pull origin release/1.1.0
29-
$ git checkout -b content/issue-xxx-the-feature
30-
```
31-
32-
Where `issue-xxx` is the corresponding issue in the GreenwoodJS project.
33-
34-
### Website
35-
36-
General changes to the website can be made by submitting a PR directly to the main branch. This includes typos, style changes, and general enhancements to the website as a whole.
37-
38-
### Link Checker
19+
## Pull Requests
3920

40-
There is a **npm** script that you can run that will check all relative links and hashes (except for blog pages) to check that links aren't broken. Running the command will build the site for production automatically and generate a report.
21+
Generally, it's best to open an issue first before submitting a Pull Request. This is a good opportunity to validate the work first, and ask any questions.
4122

42-
```sh
43-
$ npm run lint:links
44-
#...
45-
46-
✅ all links checked successfully and no broken links found
47-
```
23+
This project uses conventional commits when submitting pull requests in combination with Husky pre-commit hooks that runs linting and formatting scripts. When ready to commit code to submit a PR, run `npm run commit` and follow the prompts.
4824

4925
## Development
5026

5127
### Styling
5228

5329
All global theming and general styles should go in _src/styles/theme.css_, like font family and CSS custom properties to be used throughout the site.
5430

55-
For anything that may not be easily "componentized" or is very general like for markdown based content, it should go in _src/styles/main.css_.
31+
For anything that may not be easily "componentized" or is very general, like for markdown based content, should go in _src/styles/main.css_.
5632

5733
> [!NOTE]
5834
> [Open Props](https://open-props.style/) are used in this project to provide a set of consistent and re-usable design system tokens. Please review these first before creating any new custom values or variables.
@@ -117,10 +93,6 @@ This would emit the following generated HTML
11793
11894
For interactive components that would require client side interactivity, like event handlers, these components should be authored rendering into a Shadow Root using [Declarative Shadow DOM](https://developer.chrome.com/docs/css-ui/declarative-shadow-dom) and with Greenwood's [raw plugin](https://github.com/ProjectEvergreen/greenwood/tree/master/packages/plugin-import-raw).
11995
120-
<details>
121-
Ideally we would be using <a href="https://web.dev/articles/constructable-stylesheets">Constructable Stylesheets and Import Attributes</a> but CSS Import Attributes are <a href="https://github.com/ProjectEvergreen/www.greenwoodjs.dev/pull/57#issuecomment-2295349811">not baseline yet</a>. 😞
122-
</details>
123-
12496
```css
12597
/* card.css */
12698
.card {
@@ -334,3 +306,14 @@ The following will be required:
334306
## Continuous Integration
335307
336308
To test the CI build scripts locally, run the yarn commands mentioned in the _Workflows_ section of the README. (basically just make sure linting, formatting, and test tasks are all passing).
309+
310+
## Link Checker
311+
312+
There is a **npm** script that you can run that will check all relative links and hashes (except for blog pages) to check that links aren't broken. Running the command will build the site for production automatically and generate a report.
313+
314+
```sh
315+
$ npm run lint:links
316+
#...
317+
318+
✅ all links checked successfully and no broken links found
319+
```

0 commit comments

Comments
 (0)