Skip to content

Commit 8c54152

Browse files
committed
Add CONTRIBUTING guidelines
1 parent 027771c commit 8c54152

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to gen_surv
2+
3+
Thank you for taking the time to contribute to **gen_surv**! This document provides a brief overview of the recommended workflow for feature requests and pull requests.
4+
5+
## Getting Started
6+
7+
1. Fork the repository and create your feature branch from `main`.
8+
2. Install dependencies with `poetry install`.
9+
3. Ensure the test suite passes with `poetry run pytest`.
10+
4. If you add a feature or fix a bug, update `CHANGELOG.md` accordingly.
11+
12+
## Version Consistency
13+
14+
Releases are tagged in Git. Before creating a release, verify that the version declared in `pyproject.toml` matches the latest Git tag:
15+
16+
```bash
17+
python scripts/check_version_match.py
18+
```
19+
20+
The CI workflow `version-check.yml` runs this same script on pull requests to `main`.
21+
22+
## Submitting Changes
23+
24+
1. Commit your changes with clear messages.
25+
2. Push to your branch and open a pull request.
26+
3. Ensure your PR description explains the motivation and summarizes your changes.
27+
28+
We appreciate your contributions and feedback!

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,7 @@ This project uses Git tags to manage releases. A GitHub Actions workflow
103103
(`version-check.yml`) verifies that the version declared in `pyproject.toml`
104104
matches the latest Git tag. If they diverge, the workflow fails and prompts a
105105
correction before merging.
106+
107+
## 🤝 Contributing
108+
109+
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on setting up your environment, running tests, and submitting pull requests.

0 commit comments

Comments
 (0)