Skip to content

Add CONTRIBUTING.md #17

@KristijanArmeni

Description

@KristijanArmeni

We should add some basic guidelines on how to contribute a new test. The goal is to make it easier for new users to contribute their test and what is expected.

For now that can be a "How to contribute" section in the README.md or a standalone CONTRIBUTING.md file. Minimally, it should provide the following:

  • where to put the code for a test
  • what files must be in the folder (e.g. interface.py, main.py)
  • what each of the files mean and what contents (functions, docs etc.) should the new contributor put there
  • How to contribute once the test is written (via a pull request)

In general, the Participation guidelines section of The Turing Way book gives a nice overview of how good practices look like.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationSolely about the documentation of the project.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions