Skip to content

Commit

Permalink
Minor adjustments to documentation for contributors
Browse files Browse the repository at this point in the history
  • Loading branch information
chriscarrollsmith committed Nov 14, 2024
1 parent 451c53e commit 236b714
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ jobs:
- name: Commit and push changes to repository
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: 'Automated code format and README render'
commit_message: 'Automated code format'
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,20 @@ We welcome contributions to improve `imfp`! Here's how you can help:
- Create a fix
- Open a pull request to the `dev` branch

For maintainers: To deploy a new version:
Note that you will need to install the [Poetry](https://python-poetry.org/docs/#installation) package manager to install the dependencies and run the tests, and the [Quarto CLI tool](https://quarto.org/docs/download/) to render the documentation.

## Maintainers

To deploy a new version:
1. Increment version with `poetry version patch/minor/major`
2. Update dependencies with `poetry update`
3. Run tests with `pytest tests`
4. Update documentation if needed
5. Push to dev
6. Open PR to main

To render and deploy documentation:
1. `quarto render`
2. `quarto publish`

The GitHub Actions workflow will handle code formatting, testing, and deployment to PyPI after merge.

0 comments on commit 236b714

Please sign in to comment.