Skip to content

Commit f58a18d

Browse files
committed
Update CONTRIBUTING guide to address maintainer review feedback
- focus project description on supported data types - replace deprecated poetry shell workflow - document GH{issue-number}-{description} branch convention - improve contributor workflow clarity
1 parent b69d587 commit f58a18d

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Thanks for your interest in contributing to this project! This guide will help y
44

55
## About the project
66

7-
This package provides Python tools for accessing and analyzing genomic data from [MalariaGEN](https://www.malariagen.net/), a global research network studying the genomic epidemiology of malaria and its vectors. The package supports multiple data releases (Ag3, Af1, Amin1, Adir1, Pf7, Pf8, Pv4) and provides functionality for variant analysis, haplotype clustering, population genetics, and visualization.
7+
This package provides Python tools for accessing and analyzing genomic data from [MalariaGEN](https://www.malariagen.net/), a global research network studying the genomic epidemiology of malaria and its vectors. It provides access to data on _Anopheles_ mosquito species and _Plasmodium_ malaria parasites, with functionality for variant analysis, haplotype clustering, population genetics, and visualization.
88

99
## Setting up your development environment
1010

@@ -39,11 +39,16 @@ You'll need:
3939
pipx install poetry
4040
```
4141

42-
4. **Create and activate the development environment**
42+
4. **Install the project and its dependencies**
4343

4444
```bash
4545
poetry install
46-
poetry shell
46+
```
47+
48+
Use `poetry run <command>` to run commands inside the environment. Alternatively, activate the environment with:
49+
50+
```bash
51+
poetry env activate
4752
```
4853

4954
5. **Install pre-commit hooks**
@@ -68,14 +73,12 @@ You'll need:
6873

6974
2. **Create a feature branch**
7075

71-
Use a descriptive name:
76+
If an issue does not already exist for your change, [create one](https://github.com/malariagen/malariagen-data-python/issues/new) first. Then create a branch using the convention `GH{issue number}-{short description}`:
7277

7378
```bash
74-
git checkout -b feature/your-feature-name
75-
# or
76-
git checkout -b fix/issue-description
79+
git checkout -b GH123-fix-broken-filter
7780
# or
78-
git checkout -b docs/update-contributing-guide
81+
git checkout -b GH456-add-new-analysis
7982
```
8083

8184
3. **Make your changes**

0 commit comments

Comments
 (0)