Skip to content

Commit

Permalink
draft contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
namsaraeva authored Dec 11, 2024
1 parent d0e53fc commit 9757f2f
Showing 1 changed file with 4 additions and 32 deletions.
36 changes: 4 additions & 32 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,48 +43,20 @@ git pull --rebase
to integrate the changes into yours.
While the [pre-commit.ci][] is useful, we strongly encourage installing and running pre-commit locally first to understand its usage.

## Writing tests

```{note}
Remember to first install the package with pip install -e '.[dev]'
```
TBD

## Publishing a release

### Updating the version number

Before making a release, you need to update the version number. Please adhere to [Semantic Versioning][semver], in brief

> Given a version number MAJOR.MINOR.PATCH, increment the:
>
> 1. MAJOR version when you make incompatible API changes,
> 2. MINOR version when you add functionality in a backwards compatible manner, and
> 3. PATCH version when you make backwards compatible bug fixes.
>
> Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
Once you are done, run

```
git push --tags
```

to publish the created tag on GitHub.

## Writing documentation

Please write documentation for new or changed features and use-cases. This project uses [sphinx][] with the following features:

- Google-style docstrings
- TBD
- example code
- automatic building with Sphinx

See the [scanpy developer docs](https://scanpy.readthedocs.io/en/latest/dev/documentation.html) for more information
on how to write documentation.
on how to write documentation. (remove later)

### Tutorials with jupyter notebooks

TBD
link to notebooks repo

<!-- Links -->

Expand Down

0 comments on commit 9757f2f

Please sign in to comment.