Contributing to Atrium
Thank you very much for taking your time to contribute to Atrium
Following a few guidelines so that others can quickly benefit from your contribution.
Code of Conduct
How to Contribute
Star Atrium if you like it.
Found a bug?
Open an issue.
Missing a feature?
Create a feature request.
You would like to write an assertion function but you're having trouble starting? Please read the section Your First Code Contribution. If you still have trouble starting, then contact us on slack (Invite yourself in case you do not have an account yet) and we will try to give you some additional hints.
You do not have a particular assertion function in mind but would like to contribute with code? Please have a look at the help wanted issues -- ping us on Slack (Invite yourself in case you do not have an account yet) if there are not any.
Found spelling mistakes?
🔍Please fix it and create a pull request.
You wrote an assertion function and would like to contribute it to Atrium?
👍please review the pull request checklist and create a pull request
You would like to support the project financially?
😎this can be done via GitHub Sponsors
You have other ideas how Atrium could be improved?
Contact us on slack, we are looking forward to your ideas.
In any case, if you are uncertain how you can contribute, then contact us on
and we will figure it out together
Your First Code Contribution
Fantastic, thanks for your effort!
The following are a few guidelines on how we suggest you start.
- Fork the repository to your repositories (see Fork a repo for help).
- Use an IDE which supports Kotlin and gradle projects.
We suggest IntelliJ Community Edition.
Because of IDEA-228368 you will need at least IntelliJ 2020.1, or the Gradle import will fail.
Install the following plugins:
- EditorConfig by JetBrains (might be already activated)
- Spek Framework by Spek Team
- Import the project (import the build.gradle -> import as project, works more reliably)
- Open up a terminal (e.g. Intellij's built in -> usually ALT+F12) and run
./gradlew buildThis builds the project (compile, run tests etc) via gradle
- Read up the Coding Conventions of Atrium (there are only 5 points).
Note: IntelliJ requires a few workarounds.
- IntelliJ may warn you about duplicate content roots. Simply ignore it (IntelliJ doesn't support sharing of sources).
- IntelliJ may warn you about a Symbol being declared in an unnamed module. This is an IntelliJ bug (feel free to upvote), and can be worked around by using JDK 8, which you can switch to in File → Project Structure → Project → Project SDK.
Perfect, you are setup and ready to go.
Have a look at help wanted issues
where good first issues
are easier to start with.
Please write a comment such as
I am working on this in the issue,
this way we can assign the task to you (so that others know there is already someone working on the issue)
and it gives us the chance to have a look at the description again and revise if necessary.
Dealing with Git for the first time? Here are some recommendations for how to set up Git when working on an issue:
- create a new branch for the issue using
git checkout -b <branch-name>(preferably, the branch name should be descriptive of the issue or the change being made, e.g
#108-path-exists.) Working on a new branch makes it easier to make more than one pull request.
- add this repository as a remote repository using
git remote add upstream https://github.com/robstoll/atrium.git. You will use this to fetch changes made in this repository.
- to ensure your branch is up-to-date, rebase your work on
git rebase upstream/masteror
git pull -r upstream master. This will add all new changes in this repository into your branch and place your local unpushed changes at the top of the branch.
You can read more on Git here.
We recommend you create a pull request (see About pull requests for help)
in case you are not sure how you should do something.
This way we can give you fast feedback regarding multiple things (style, does it go in the right direction etc.) before you spend time for nothing.
Prepend the title with
[WIP] (work in progress) in this case and leave a comment with your questions.
Finally, when you think your PR (short for pull request) is ready, then please:
- read the Pull Request Checklist
- Create your first pull-request
👏 👏 👏you have submitted your first code contribution to Atrium 😊
So far we do not try to enforce too much. We will review your patches and comment if necessary. However, here a few hints in order that your pull request is merged quickly.
- Make sure the compiler does not generate warnings.
- Try to write code in a similar style as the existing (We suggest you copy something existing and modify it).
- Write readable code and express comments with code rather than comments.
- Provide tests in form of Spek specifications.
- Write your commit message in an imperative style.
Pull Request Checklist
Please make sure you can check every item on the following list before you create a pull request:
- your pull request is rebased on the latest commit on master
- Your pull request addresses only “one thing”. It cannot be meaningfully split up into multiple pull requests.
Once you have created and submitted your pull request, make sure:
- your pull request passes Continuous Integration and all other checks