Skip to content

Commit

Permalink
Merge pull request #173 from JCSzamosi/clarify-contrib-links
Browse files Browse the repository at this point in the history
Clarify issues links in CONTRIBUTING.md
  • Loading branch information
gcapes authored Sep 26, 2023
2 parents ce5740a + 1c09898 commit ba269bd
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,13 @@ introduce yourself and to meet some of our community members.

2. If you have a [GitHub][github] account, or are willing to [create
one][github-join], but do not know how to use Git, you can report problems
or suggest improvements by [creating an issue][issues]. This allows us to
assign the item to someone and to respond to it in a threaded discussion.
or suggest improvements by [creating an issue][repo-issues]. This allows us
to assign the item to someone and to respond to it in a threaded discussion.

3. If you are comfortable with Git, and would like to add or change material,
you can submit a pull request (PR). Instructions for doing this are
[included below](#using-github).
[included below](#using-github). For inspiration about changes that need to
be made, check out the [list of open issues][issues] across the Carpentries.

Note: if you want to build the website locally, please refer to [The Workbench
documentation][template-doc].
Expand All @@ -49,8 +50,8 @@ There are many ways to contribute, from writing new exercises and improving
existing ones to updating or filling in the documentation and submitting [bug
reports][issues] about things that do not work, are not clear, or are missing.
If you are looking for ideas, please see [the list of issues for this
repository][repo], or the issues for [Data Carpentry][dc-issues], [Library
Carpentry][lc-issues], and [Software Carpentry][swc-issues] projects.
repository][repo-issues], or the issues for [Data Carpentry][dc-issues],
[Library Carpentry][lc-issues], and [Software Carpentry][swc-issues] projects.

Comments on issues and reviews of pull requests are just as welcome: we are
smarter together than we are on our own. **Reviews from novices and newcomers
Expand Down Expand Up @@ -102,6 +103,7 @@ media, slack, newsletters, and email lists. You can also [reach us by
email][contact].

[repo]: https://example.com/FIXME
[repo-issues]: https://example.com/FIXME/issues
[contact]: mailto:team@carpentries.org
[cp-site]: https://carpentries.org/
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
Expand All @@ -111,7 +113,7 @@ email][contact].
[github]: https://github.com
[github-flow]: https://guides.github.com/introduction/flow/
[github-join]: https://github.com/join
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
[how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
[issues]: https://carpentries.org/help-wanted-issues/
[lc-issues]: https://github.com/issues?q=user%3ALibraryCarpentry
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
Expand Down

0 comments on commit ba269bd

Please sign in to comment.