Skip to content

Commit 2b9204a

Browse files
authored
📄add additional steps in contribution guide (#268)
1 parent 1d4b30c commit 2b9204a

2 files changed

Lines changed: 22 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111

12+
- (docs) improve contribution guidelines
13+
1214
### Changed
1315

1416
### Fixes

docs/source/contributing.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
- [7. Setting up pre-commit](#7-setting-up-pre-commit)
1616
- [8. Backward-compatibility guidelines](#8-backward-compatibility-guidelines)
1717
- [9. Release process](#9-release-process)
18+
- [9.1. Github](#91-github)
19+
- [9.2. conda-forge](#92-conda-forge)
20+
- [9.3. Readthedocs](#93-readthedocs)
1821

1922
## 1. Contributor License Agreement (CLA)
2023

@@ -184,7 +187,9 @@ These guidelines help keep PLAID users' code and datasets working across release
184187

185188
## 9. Release process
186189

187-
- Create a new release branch from `main`
190+
### 9.1. Github
191+
192+
- Create a new release branch from `main` called e.g. `release_0.1.10`
188193
- Update the CHANGELOG
189194
- Rename the section [Unreleased] to the new version number (e.g., [0.1.10]) followed by the release date (YYYY-MM-DD)
190195
- Update links at the end of the file
@@ -195,3 +200,17 @@ These guidelines help keep PLAID users' code and datasets working across release
195200
- Click `Generate release notes`
196201
- Include a link to the CHANGELOG file at the release tag, e.g.: `https://github.com/PLAID-lib/plaid/blob/0.1.10/CHANGELOG.md`
197202
- Create a new pull request to add a new `Unreleased` section to the CHANGELOG, with sub-sections `Added`, `Changed`, `Fixes`, `Removed`
203+
204+
### 9.2. conda-forge
205+
206+
- Create a fork of https://github.com/conda-forge/plaid-feedstock or sync with the latest changes if you already have a fork
207+
- Update the conda-forge recipe `plaid-feedstock/recipe/meta.yaml`
208+
- Update the `version` field to the new version number (line 1)
209+
- Update the SHA256 checksum for the new version (line 9), you can find it in the GitHub action: https://github.com/PLAID-lib/plaid/actions/workflows/checksum_release.yml, don’t take the one in `Digest` section of `Artifacts`, but take the one in the download button
210+
- Update requirements section if they change in the new version
211+
- Submit a pull request to the conda-forge feedstock repository
212+
- Follow the instructions provided in the PR message
213+
214+
### 9.3. Readthedocs
215+
216+
Just check a version was created for the release tag, it should have automatically triggered a new build on Read the Docs.

0 commit comments

Comments
 (0)