You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17-30Lines changed: 17 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,51 +8,27 @@ The layout of the project is as follows:
8
8
9
9
-_/assets/_ - Public assets like images and fonts used throughout the site
10
10
-_/components/_ - Custom Element web components to be used throughout the project
11
+
-_/layouts/_ - Page level layouts for various section of the website
11
12
-_/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
13
14
-_/styles/_ - Global theme and styles
14
15
15
16
> [!NOTE]
16
17
> 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.
17
18
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
39
-
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.
19
+
## Pull Requests
41
20
42
-
```sh
43
-
$ npm run lint:links
44
-
#...
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.
45
22
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.
48
24
49
25
## Development
50
26
51
27
### Styling
52
28
53
29
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.
54
30
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_.
56
32
57
33
> [!NOTE]
58
34
> [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.
@@ -334,3 +310,14 @@ The following will be required:
334
310
## Continuous Integration
335
311
336
312
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).
313
+
314
+
## Link Checker
315
+
316
+
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.
317
+
318
+
```sh
319
+
$ npm run lint:links
320
+
#...
321
+
322
+
✅ all links checked successfully and no broken links found
0 commit comments