docs: avoid duplication about the contributing guide - Githubissues

osl-incubator / scicookie

Cookiecutter template for a Python package.

https://osl-incubator.github.io/scicookie

Other

11 stars 18 forks source link

docs: avoid duplication about the contributing guide #228

Closed xmnlab closed 4 months ago

xmnlab commented 4 months ago

Pull Request description

How to test these changes

...

Pull Request checklists

This PR is a:

[ ] bug-fix
[ ] new feature
[ ] maintenance

About this PR:

[ ] it includes tests.
[ ] the tests are executed on CI.
[ ] the tests generate log file(s) (path).
[ ] pre-commit hooks were executed locally.
[ ] this PR requires a project documentation update.

Author's checklist:

[ ] I have reviewed the changes and it contains no misspelling.
[ ] The code is well commented, especially in the parts that contain more complexity.
[ ] New and old tests passed locally.

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved

xmnlab commented 4 months ago

when we start to use mkdocs, IIRC we don't need to keep both files, we can point in the menu to a file outside of the docs folder

github-actions[bot] commented 4 months ago

:tada: This PR is included in version 0.7.0 :tada:

The release is available on:

0.7.0
GitHub release

Your semantic-release bot :package::rocket: