Every issue will be reviewed by at least one of the lead authors. They have the authority to decide whether the issues is a minor or major change. Minor changes can be accepted directly after one review of the lead authors. Major changes requires at least 3 reviews by co-authors with relevant knowledge on the specific topics. All major changes will remain open for at least 4 weeks to allow all co-authors to provide feedback. Every co-author can request a change to be reverted and request further discussion to reach a new consensus. Co-authors are encouraged to periodically review GitHub activity as co-authorship implies agreement with the content.
- typos, language and formatting
- adding images
- adding new sensor descriptions
- change of uncertainties ranges
- concrete suggestions i.e. related to correction of methods
Please read our [Code of Conduct](add link when final) before contributing.
Important: We aim to have an organized discussion. Thus before adding new comments below sections, please always look at open issues and join the ongoing dicussion there.
You can contribute in two ways: Case 1 - comment directly on the online document, Case 2 - make a concrete suggestion to the online document via a pull request
- Read the Oxygen SOP here
- Scroll down to make your comment at the end of each section.
- Log into your GitHub account
-
Make your comment, describe the problem in a concise and organized way and only raise one major point per comment.
-
An issue is created automatically in the GitHub repository, which will be reviewed by the lead authors.
In general, we suggest to start a discussion (‘issue”) before directly editing the document via a “pull-request”. In particular if you request ‘major changes’. Editing the documents directly will require some basic markdown knowledge.
- Read the Oxygen SOP here
- Scroll up, move your mouse over the GitHub symbol and click "suggest edit".
- The markdown file of the section is opened.
- Edit the document using markdown.
- Make a pull request, tell us briefly why you made changes, and submit.
- The SOP team will review your changes as outline above, and if approved, the process is complete and you're done.
- All contributers will be listed as co-authors on the next peer-reviewed publication.
We are happy to provide individual training sessions for people who are new on GitHub. Please indicate your interest here so we can organize sessions.