Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

54 lines (39 loc) · 2.32 KB
Raw

Contributing to our project on teaching RSE

This paper is intended as a collaborative effort and we are looking for input from you!

You can contribute in various ways:

  • Propose content/text via pull request
  • Improve existing content via pull request
  • Review or comment on pull requests of others

Nevertheless we follow some rules:

We Develop with GitHub

We use GitHub to host the paper, to track issues and feature requests, as well as accept pull requests.

We Use GitHub Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the source material (we use Github Flow). We actively welcome your pull requests:

  • optional: open issue describing what you want to do
  • Fork this repository
  • Create your changes in your fork
  • Go to the pull requests page of this repository and push new pull request
  • You can add DRAFT, or WIP to indicate work-in-progress PRs.
  • Add a short description

How to review existing pull requests

  • Go to the pull requests page of this repository
  • Click on any of the open pull requests
  • Leave comments under Conversation or do a full review under Files changed

Formatting, etc

For writing text, Please utilise semantic line breaks! We utilise tags to categorise issues and PRs to the respective paper. Please also note, that we use British english instead of American english.

Becoming an Author

If you want to become an author of the project open a PR that adds the relevant information to contributors.yml (At the end of the file you find a template for the fields) Make sure the name provided in the "author:" field matches exactly with the name in the Markdown preamble author list.

We aim to be inclusive for everyone who wants to become a contributor.

Publication

We currently have split the topic of teaching RSEs in Germany across four papers. We aim for a publication of most of these papers. All people that have participated in discussions with us, e.g. at deRSE23 or undeRSE23 are at least eligible for contributor status. If you have participated regularly at our weekly working meetings(try to reach out to [email protected]) you are eligible for authorship.