Skip to content

Commit

Permalink
docs: revised CONTRIBUTING.md with formatting and wording updates
Browse files Browse the repository at this point in the history
  • Loading branch information
JennyonOort committed Jan 9, 2025
1 parent 1fb7dda commit 91301d9
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ 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][new_issues]. This allows us to
or suggest improvements by [creating an issue][new-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,
Expand All @@ -49,8 +49,8 @@ Please tag an administrator as a reviewer to ensure your PR is reviewed promptly
### What to Contribute

There are many ways to contribute, from implementing new features and improving
existing ones to updating or filling in the documentation and submitting [bug
reports][issues] or fixing bugs about things that do not work, are not clear, or are missing.
existing ones to updating or filling in the documentation and submitting bug
reports or fixing bugs about things that do not work, are not clear, or are missing.

### Contribution Guidelines

Expand Down Expand Up @@ -85,15 +85,15 @@ Linux users; in order to be usable, our package must run equally well on all
three.

### Attribution
This Code of Conduct is inspired by [Software Carpentry CONTRIBUTING.md][attribution].
This `CONTRIBUTING.md` is adapted from [Software Carpentry CONTRIBUTING.md][attribution].

[attribution]: https://github.com/swcarpentry/r-novice-inflammation/blob/main/CONTRIBUTING.md
[contact]: mailto:[email protected]
[github]: https://github.com
[github-flow]: https://guides.github.com/introduction/flow/
[github-join]: https://github.com/join
[how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
[issues]: https://github.com/UBC-MDS/SharpEdge/issues
[new_issues]: https://github.com/UBC-MDS/SharpEdge/issues/new
[issues]: https://docs.github.com/en/issues/tracking-your-work-with-issues/configuring-issues/quickstart
[new-issues]: https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-an-issue
[pull-request]: https://help.github.com/en/articles/creating-a-pull-request
[repo]: https://github.com/UBC-MDS/SharpEdge

0 comments on commit 91301d9

Please sign in to comment.