ISA-tools / ISA-tools/isa-api

Add Code Contributor Guidelines (covering coding style and process + examples)

Open
#316 1 comment 0 reactions 1 assignee View on GitHub

@proccaserra is already working on this.

Since Mar 1, 2021.

doc low priority
Dominant language
Python
Stars
48
Forks
42
PR merge metrics
No merged PRs in 30d

Description

There needs to be more documentation directed at prospective developers who wish to contribute to ISA API (features/fixes), as the docs currently are targeted at developer-users only. This includes adding more docstrings embedded in the ISA API code itself.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.