First of all, thank you for your contribution to the RGSoC Teams App. Or the consideration thereof. 😄 The Teams App is a collaborative effort of many contributors.
Please note our Code of Conduct.
There are different ways to get involved:
- Find work that needs to be done
- Reporting an error
- Suggesting a new feature
- Resolving an existing issue
How things are organized:
We use labels to track, manage and organize issues and pull requests.
| Label Name | Issues | Description |
|---|---|---|
beginner-friendly |
🔍 | Less complex issues, suitable for your first steps in open source. |
bug |
🔍 | Confirmed misbehavior of the application code. |
duplicate |
🔍 | Issues which have already been reported. |
in progress |
🔍 | Work in progress, things which are already taken care of. |
invalid |
🔍 | Issues which aren't "real" issues (e.g. user errors). |
#pairwithme |
🔍 | Looking for someone to pair on this. |
question |
🔍 | Feature and code related questions which are no bug reports or feature requests. |
rgsoc-<year> |
🔍 | Issues intended for students working on the Teams App during RGSoC in a given <year>. |
styling |
🔍 | CSS and UI related things. |
wontfix |
🔍 | The team has decided to not fix these things for now, e.g. because the whole feature will be replaced soon. |
would be nice |
🔍 | Features and enhancement which are "nice to have" but not super necessary. |
Reporting a bug is very important and we appreciate the time you take to inform us about the Teams App's mischief. Before you do, we kindly ask you to check if it has already been reported.
If you do file a new bug report, provide as many details as possible: how can the error be reproduced? What was the expected and what the actual behaviour? Can you provide an error message or a screenshot that illustrates the problem?
We are very open to feature requests and ideas to improve the Teams App. If you are a RGSoC student or supervisor who uses the Teams App on a daily basis over the course of the summer, your feedback on how the user experience can be improved is very valuable.
As with filing a bug report, please check if the feature has already been suggested. If not, share your ideas!
If you want to get involved with the RGSoC Teams App, the list of open issues is a good starting point.
We have issues labelled as beginner-friendly suitable for your first steps in open source. See #pairwithme for more involving issues and the standing invitation to work on a problem together (check this great list of resources about (remote) pair programming).
Before you start working, make sure no one else is already working on it: check if the issue has been assigned to someone already and/or comment on the issue. Adding comments is also the best way to ask questions about the issue at hand or if the issue is still valid.
If you've confirmed that no one is working on the issue and would like to give it a go, feel free to leave a comment saying so! You could write something like the following:
I think I know how to fix this one! Will give it a try :thumbsup:
Clone/fork the repo and install the Teams App locally on your computer. Our README provides setup instructions and hints).
Before you start working, make sure tests pass locally: run bundle exec rake spec from the terminal in your local Teams App directory. There should be plenty of green dots (and some in yellow).
All commits should go into a branch, not to master directly. Create a local branch:
git checkout -b my-feature-branch
If you've cloned the app a while ago, you want to make sure that your cloned master is in sync with the upstream. Github provives a help page on how to keeping your fork in sync with upstream/master.
We aim to follow the Ruby Style Guide and have RuboCop set up to make sure we stay consistent with some basic rules (see our rubocop.yml file for details).
But don't be afraid, those are friendly cops who are here to help you with formatting your code 👮
We prefer JavaScript (*.js) over CoffeeScript (*.coffee). jQuery is perfectly fine, but if you can, use Vanilla JS instead of jQuery. Indentation for JavaScript files: four whitespaces.
If you enjoy polishing up other people's code: be aware that purely code-cosmetic changes are likely to not be accepted. We aim to be welcoming to beginners. So while e.g. pointing out accidental N+1 queries is a useful contribution, just rewriting things to look more conventional can be discouraging for newcomers.
We would ask you to write tests for your code: A well defined test suite is as much part of the app as the tested code itself. It helps to ascertain the well-being of any software product - the Teams App being no exception here. But this should not be a blocker. See the existing tests to find out where yours would fit in and in case it's hard to get started, ask us, we'll help.
Make atomic commits with a descriptive commit message.
Github provides documentation on how to create a PR. A new PR (and any subsequent updates to it) will trigger running the test suite and automatic code analyzers on Travis CI.
If your contribution alters the way the Teams App looks (e.g. CSS changes), we kindly ask you to provide a few screenshots (before/after) that illustrate the change. It's much easier and quicker to review as we won't have to checkout the PR locally. You can drag'n'drop image files directly into the PR description or its comments section.
Please give us a few days to get back to you. Thank you so much!
You and a person reviewing your code agreed to update your pull request with certain changes? Please @-mention the person in the comments once you are done and the code is ready to be reviewed again.