Skip to content

Commit 5e1b309

Browse files
author
Ethan Shanahan
committed
isolated contributing info
1 parent cc6f1ca commit 5e1b309

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing
2+
3+
If you are planning on contributing to AiiDA-FANS, please consider the following guidelines. Additionally, it is strongly recommended to use the pixi package manager to install the appropriate development environment. After cloning this repository, simply run `pixi install` and use the default environment.
4+
5+
## Development
6+
1. Branch off `dev` with a name appropriate for what you are working on (e.g. `feat/myfeature` or `bug/badbug`).
7+
2. Implement, commit, and push your changes.
8+
3. Open a Pull Request into `dev` (e.g. `dev ← feat/myfeature`), then merge and delete your branch.
9+
10+
## Release
11+
1. Open a Pull Request `main ← dev`, then merge but do **not** delete `dev`.
12+
2. Draft a new Release and assign it a new Tag according to the new version number (e.g. `v1.2.3`).
13+
3. Generate release notes and publish the Release.

0 commit comments

Comments
 (0)