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
{{ message }}
This repository was archived by the owner on Nov 4, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,25 +19,27 @@ reported the issue. Please try to include as much information as you can. Detail
19
19
* Any modifications you've made relevant to the bug
20
20
* Anything unusual about your environment or deployment
21
21
22
-
## Running this website locally
23
-
If you are interested in contributing with content, you can run the workshop website in your local computer using the [Hugo CLI](https://gohugo.io/getting-started/installing/).
22
+
## Contributing via Pull Requests
23
+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that you are working against the latest source on the `dev` branch.
24
+
25
+
### Run project locally
26
+
The static website is built using Hugo and to run it locally you need to install the [Hugo CLI](https://gohugo.io/getting-started/installing/).
24
27
25
28
1. Clone this repository.
26
29
2. Switch to the _dev_ branch. (`git checkout dev`).
27
30
3. Run `hugo serve` from within the _workshop_ folder.
28
31
29
-
## Contributing via Pull Requests
30
-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
32
+
Please keep in mind the following before sending a pull request.
31
33
32
-
1. You are working against the latest source on the `dev` branch.
33
-
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
34
-
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
34
+
- You are working against the latest source on the `dev` branch.
35
+
- You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
36
+
- You open an issue to discuss any significant work - we would hate for your time to be wasted.
35
37
36
38
To send us a pull request, please:
37
39
38
40
1. Fork the repository.
39
41
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
40
-
3. Ensure local tests pass.
42
+
3. Ensure you test locally using Hugo CLI.
41
43
4. Commit to your fork using clear commit messages.
42
44
5. Send us a pull request, answering any default questions in the pull request interface.
43
45
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
0 commit comments