Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

28 lines (22 loc) · 2.58 KB
Raw

CLARIAH Use Cases: Contribution Guidelines

  1. Each use case is described by a Markdown file in the cases/ directory, one file per use-case.
    • Choose a simple descriptive filename, avoid spaces, and mind that filenames are case-sensitive.
    • All documents should be plain text following Markdown syntax and always use the UTF-8 character encoding. Use the .md extension.
    • We recommend you use this template as a basis for your use case document, but feel free to add things or deviate from it if it's not sufficient for your needs. Do make sure to check out the template for an idea of the information we request.
    • You can use any text editor you like, or edit online through the interface offered by Github.
  2. Link to your document from the README.md, where you have room for a simple title and optionally a short description. You can just copy and adapt one of the existing entries.
  3. Submit your contributions by pushing directly to this repository if you as a Pull Requests. This automatically opens up a thread for discussion and peer review of your contributions and will notify all group members. A coordinator can finally approve and merge your contributions.
    • Trivial contributions (spelling corrections etc) can be contributed directly if you have push access to the repository.
    • If you prefer to push directly to the repository and skip the review/discussion stage offered by the Pull Request, then that is fine too at this point in time.

Help for beginners

If you're new to git and github and this looks a bit daunting to you, then don't panic! You can simply edit directly from github's interface as follows:

  1. Make sure you have a Github account and are logged in
  2. Go to https://github.com/CLARIAH/usecases/tree/master/cases directory, click the Add file button on the top-right and select Create new file.
  3. Copy the contents from https://raw.githubusercontent.com/CLARIAH/usecases/master/TEMPLATE.md , paste it into the text field and adapt it.
  4. Enter a filename in the Create field, make sure it is a simple descriptive filename without no spaces, prerefably all lowercase and ends in .md. You can optionally enter a short description in the field below.
  5. Choose the Create a new branch for this commit and start a pull request. option and press Commit new file,
  6. Submit the pull request in the new form that appears