You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[ ] 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).
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,9 @@
1
+
1
2
# Contributing to TeSS
2
3
3
4
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.
4
5
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.
5
7
6
8
### TeSS Club
7
9
@@ -116,8 +118,15 @@ or if using docker:
116
118
docker compose run test
117
119
```
118
120
121
+
or for a specific test
122
+
```
123
+
docker compose run --remove-orphans test rails test test/<PATHTOYOURTEST>
124
+
```
125
+
119
126
You can also see the test coverage % after the tests finish - make sure it has not decreased from before adding your code.
120
127
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
+
121
130
### Commit Meaningfully
122
131
123
132
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
135
144
- Why the changes were made, with links to any relevant issues or discussions.
136
145
- If appropriate, screenshots of the changes, or instructions on how the changes can be tried out.
137
146
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
+
138
154
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).
139
155
140
156
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:
154
170
155
171
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.
156
172
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/)
0 commit comments