Skip to content

Commit ce295f0

Browse files
committed
docs(contributing.md): emphasis on code checklist
1 parent 79fc1d5 commit ce295f0

2 files changed

Lines changed: 29 additions & 16 deletions

File tree

.github/pull_request_template.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,4 @@
1313
**Checklist**
1414

1515
- [ ] I have read and followed the [CONTRIBUTING](https://github.com/ElixirTeSS/TeSS/blob/master/CONTRIBUTING.md) guide.
16-
- [ ] I confirm that I have the authority necessary to make this contribution on behalf of its copyright owner and agree
17-
to license it to the TeSS codebase under the
18-
[BSD license](https://github.com/ElixirTeSS/TeSS/blob/master/LICENSE).
19-
20-
**Code checklist**
21-
22-
- [ ] Changes are covered by tests
23-
- [ ] There is clear logging and error handling
24-
- [ ] Documentation is updated
25-
26-
**To ease the reviewer's work**
27-
28-
- Review your own code
29-
- Add context to smaller changes
30-
- Highlight important parts
31-
- Ask specific questions if needed
16+
- [ ] I confirm that I have the authority necessary to make this contribution on behalf of its copyright owner and agree to license it to the TeSS codebase under the [BSD license](https://github.com/ElixirTeSS/TeSS/blob/master/LICENSE).

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
12
# Contributing to TeSS
23

34
While TeSS was originally developed to serve as the training portal for [ELIXIR](https://www.elixir-europe.org/), it endeavours to be a generic training platform that can be easily customized and re-used in other communities.
45
To that end we welcome and encourage new contributors to get involved and help to shape and improve TeSS. This document discusses and explains different ways you can contribute to TeSS.
6+
You can find a code checklist at the end of this document to summarize the important points.
57

68
### TeSS Club
79

@@ -116,8 +118,15 @@ or if using docker:
116118
docker compose run test
117119
```
118120

121+
or for a specific test
122+
```
123+
docker compose run --remove-orphans test rails test test/<PATHTOYOURTEST>
124+
```
125+
119126
You can also see the test coverage % after the tests finish - make sure it has not decreased from before adding your code.
120127

128+
Please setup your local IDE to see the test coverage of your code (e.g., Coverage Gutters in VSCode) – as said before, a pushed code should be close to 100% test coverage.
129+
121130
### Commit Meaningfully
122131

123132
Make sure your commits contain meaningful and related changes, and a commit message describing the change.
@@ -135,6 +144,13 @@ Make sure that your feature branch is pushed to your fork of TeSS on GitHub and
135144
- Why the changes were made, with links to any relevant issues or discussions.
136145
- If appropriate, screenshots of the changes, or instructions on how the changes can be tried out.
137146

147+
Other points to be aware of to ease the reviewer's work:
148+
149+
- Review your own code
150+
- Add context to smaller changes
151+
- Highlight important parts
152+
- Ask specific questions if needed
153+
138154
Also be sure to select the branch of TeSS where you want the changes to be merged back into, and if your contribution is a work-in-progress, flag the pull request as being a "Draft" (Click the arrow next to the "Create Pull Request" button).
139155

140156
Your pull request should trigger a build that can be monitored on our [actions](https://github.com/ElixirTeSS/TeSS/actions) page. The core TeSS development team will also be notified, and a member of the team will review your Pull Request in a timely manner.
@@ -154,6 +170,18 @@ TeSS has various levels of documentation that can also be contributed to:
154170

155171
Small changes can be made directly in GitHub. Simply open the relevant file, click the pencil icon to edit, make your change, and click the "Proprose changes" button - GitHub will automatically create a fork, a feature branch and a pull request for you.
156172

173+
# Code contribution checklist
174+
175+
- [ ] I agree to redistribute my work under [our BSD 3-Clause licence](LICENSE)
176+
- [ ] I followed the [Code of Conduct](CODE_OF_CONDUCT.md)
177+
- [ ] Issue is opened or I commented on an existing one
178+
- [ ] I followed [Ruby Style Guide](https://github.com/rubocop/ruby-style-guide)
179+
- [ ] Commits are meaningful
180+
- [ ] Changes are covered by tests
181+
- [ ] There is clear logging and error handling
182+
- [ ] Documentation is updated
183+
- [ ] I advertised my contribution in the [TeSS Club meetings](https://elixirtess.github.io/about/)
184+
157185
# Thank You
158186

159187
Thank you for considering contributing to TeSS.

0 commit comments

Comments
 (0)