Welcome to the new flatland repository 🚂😃

[manuschn]

Welcome to our new repository here on GitHub.

Let's start simple and add complexity as we need it. Whenever you feel like you are missing something or some current setup doesn't server your needs, start a new discussion in this repository or bring it up during the next dev-meeting.

Discussions are also the place to bringup new ideas, propose changes to processes or structure, and where we document conclusions from our dev-meetings. Use the ideas category for brainstorming kind of discussions and early stage ideas, and the general category for more concrete proposals.

Working on issues

Issues and pull requests (PR) help us organize our work:

• have an overview of the work to do and tackle it in a coordinated manner (prioritization in dev meetings etc.)
• communicate what we are working on to avoid duplicate work and to focus efforts
• make it easy for others to join by making thought processes visible

Choosing an issue

If you start working (or plan to work) on one or several issues, do the following for each to let others know:

• open the issue
• assign yourself to the issue by clicking on the Add assignees ... button
• change the status to In Progress by clicking on the status (usually Todo)

Start implementing

When you start implementing (parts of) the issue, create a new branch (of the main branch) with a descriptive name, eg. benchmark-utils-cleanup and push it to the GitHub repository (or create the branch through the GitHub UI). Go to Pull requests and you should see the a suggestion to create a new PR for your newly created branch.

In any case, always describe briefly the scope of the PR you create to make sure others know what you are working on. Also mention the issue it addresses by using the issue id (#). If the PR matches exactly one issue, you may just link to the issue by using the Fixes, Closes, Resolves keywords followed by the id of the issue, eg. Fixes #6. This will automatically close the issue when the PR is merged.

Large issues

If an issue has a large scope, you may want to separate your work into multiple PRs. In general, create a new branch for each PR.

If you will not tackle the entire issue (eg. it is too much workload for you alone or there is stuff you are unfamiliar with) and leave the rest for someone else, you best create new issues for the tasks in the issue and link them in the issue text by using the issue ids, eg. (see #5).

Before merging

Before you merge a PR, request a review. For now, request reviews from @aiAdrian if you work on an Enhancement or from @mmarti-tsch if you work on a Documentation issue. They can also delegate revisions to other members of the core team by requesting a review from someone else. The idea behind this approach is that the current leads in an area have an overview of what is done and check for consistency across all issues in that area.