guide

Contributor Guide

General rules

• Be as concise as possible
• Sign-up your Wiki contributions
• Document your use-case contributions with README files.
• README must be use some light markup language (RST, MD or txt).
• Avoid storing code in the repository, put links and how to tips in the README instead.
• Contributions must be published by using Pull Requests (PR).
• We people can work on either their own clone or branch. In the latest case, the branch must be named in the way that the author can be easily be identified.
• The Wiki is not the place for discussions. Discussions must take place in the issues.
• Contributor must not create new Wiki sections. It is however possible (but not encouraged) to create on purpose new pages within an existing section.

Contributions

Adding a new use case

• A new-sub directory must be created in usecases.
• The sub-directory name must denote the purpose of the use-case (e.g. radial-velocity).
• The use-case content must be as follow:
  • README file describing the case.
  • A raw_data subdirectory containing one or more datasets which content matches the usecase.
  • A README can be added in raw_data to tell more about the raw datasets.

Adding a new proposal

• Create a folder in the usecase directory
• Give that folder a name that allows to easily identify the proposal (e.g json_proposal for a proposal based on json serialisation)
• Put a README there
• Repeat this operation for all usecases processed by your proposals

Commenting on a proposal

• Comments or questions focused on specific points of usecases or proposals must be addressed with issues
• General comments on proposals must be published in the dedicated Wiki page.

Follow up

• The repository activity will be reported from time to time on Slack and by Email in the DM WG list
• People can get notified by activating the watch popup on the top right of the project page.