Fixing links and clarifying a couple of points
Signed-off-by: Ivan Boothe <git@rootwork.org>
+19 −13 · 1 file changed
-
CONTRIBUTING.md+19 −13
@@ -27,13 +27,14 @@ rather than posting an issue. You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by -[submitting an issue](https://github.com/chipzoller/hugo-clarity/issues). -Before you create an issue, make sure to search the issue archive -- your issue -may have already been addressed! +[submitting an issue](https://github.com/chipzoller/hugo-clarity/issues/new/choose). +Before you create an issue, make sure to +[search the current issues](https://github.com/chipzoller/hugo-clarity/issues) +-- your issue may have already been addressed! Once a bug has been confirmed or a feature has been approved, you are welcome -to [submit a Pull Request](#submit-a-pull-request) -- if you have the solution, -please do tell us about it! +to [submit a Pull Request](#how-to-submit-a-pull-request) -- if you have the +solution, please do tell us about it! ### Helping us fix bugs @@ -52,9 +53,9 @@ order to help us help you, create bug reports that are: ## How to submit a Pull Request 1. Search our repository for open or closed - [Pull Requests](https://github.com/chipzoller/hugo-clarity/pulls) that - relate to your issue. You don't want to duplicate effort, and if one already - exists you can collaborate on that. + [Pull Requests](https://github.com/chipzoller/hugo-clarity/pulls?q=is%3Apr+sort%3Aupdated-desc) + that relate to your issue. You don't want to duplicate effort, and if one + already exists you can collaborate on that. 2. Ensure that you plan to work consistent with the [Developer Certificate of Origin](https://developercertificate.org/). This @@ -64,8 +65,11 @@ order to help us help you, create bug reports that are: in order to contribute to Hugo Clarity**, and you'll need to confirm your consent when committing, as shown below. -3. Clone the project using [Gitpod](https://github.com/chipzoller/hugo-clarity#option-1a-development-in-the-browser) - or [locally on your machine](https://github.com/chipzoller/hugo-clarity#option-1b-development-on-your-machine) +3. [Fork the project](https://docs.github.com/en/get-started/quickstart/fork-a-repo), + then checkout your fork using + [Gitpod](https://github.com/chipzoller/hugo-clarity/blob/master/README.md#getting-up-and-running) + or + [locally on your machine](https://github.com/chipzoller/hugo-clarity/blob/master/README.md#option-1b-development-on-your-machine) 4. Create a new branch: @@ -91,7 +95,7 @@ order to help us help you, create bug reports that are: 7. Repeat steps 5-6 as necessary. 8. Unless your PR is documentation-only, **test your work - [using Hugo extended](https://github.com/chipzoller/hugo-clarity#prerequisites) + [using Hugo extended](https://github.com/chipzoller/hugo-clarity/blob/master/README.md#prerequisites) to build a site.** When you submit your PR we'll run test-builds of a Hugo site with your PR applied, so you'll save time if you fix any build issues before submitting. @@ -103,7 +107,9 @@ order to help us help you, create bug reports that are: ``` 10. [Open a Pull Request](https://github.com/chipzoller/hugo-clarity/compare?expand=1) - and wait for feedback. Filling out the PR as requested will ensure your work - gets reviewed by maintainers promptly. + by + "[comparing across forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)" + and filling out the form. Completing the PR template as requested will ensure + your work gets reviewed by maintainers promptly. ## 🎉 **Thank you for your contribution!**