Skip to content

[JOSS REVIEW] Add CONTRIBUTING guidelines #177

@Zeitsperre

Description

@Zeitsperre

It would be great to have a dedicate section for advice on how best to contribute to the project. Some examples of relevant information:

  • How to fork and clone the repo
  • Suggested development installation steps
  • Types of contributions that are accepted
  • How to run the tests / build the docs
  • Quality control steps
  • Other considerations for Pull Requests

This is a relatively generic (albeit comprehensive) example from a repo I maintain: https://github.com/Ouranosinc/xsdba/blob/main/CONTRIBUTING.rst. Feel free to be inspired/copy the relevant portions as needed. This could also be wrapped into the discussion for #150.

Context: openjournals/joss-reviews#9688

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions