Skip to content
This repository was archived by the owner on Nov 4, 2022. It is now read-only.

Commit 0e9d5cc

Browse files
committed
Updated contribution guidelines.
1 parent d020707 commit 0e9d5cc

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,27 @@ reported the issue. Please try to include as much information as you can. Detail
1919
* Any modifications you've made relevant to the bug
2020
* Anything unusual about your environment or deployment
2121

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/).
2427

2528
1. Clone this repository.
2629
2. Switch to the _dev_ branch. (`git checkout dev`).
2730
3. Run `hugo serve` from within the _workshop_ folder.
2831

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.
3133

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.
3537

3638
To send us a pull request, please:
3739

3840
1. Fork the repository.
3941
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.
4143
4. Commit to your fork using clear commit messages.
4244
5. Send us a pull request, answering any default questions in the pull request interface.
4345
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ In this workshop, you will learn how to start a new Serverless application from
88

99
[https://cicd.serverlessworkshops.io](https://cicd.serverlessworkshops.io)
1010

11+
## Want to contribute?
12+
13+
Check our [contribution guidelines](CONTRIBUTING.md) before submitting a pull request. Any contribution must be done to the `dev` branch.
14+
1115
## License
1216

1317
This library is licensed under the MIT-0 License. See the LICENSE file.

0 commit comments

Comments
 (0)