osl-incubator / scicookie

Cookiecutter template for a Python package.
https://osl-incubator.github.io/scicookie
Other
11 stars 18 forks source link

docs(upgrade): add section in contributing guide and new installation page #238

Closed Naman-Priyadarshi closed 6 months ago

Naman-Priyadarshi commented 6 months ago

Pull Request description

Added a new page for installation and a section for documentation development in contributing.md.

A small step towards #191

How to test these changes

Pull Request checklists

This PR is a:

About this PR:

Author's checklist:

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
Naman-Priyadarshi commented 6 months ago

@Saransh-cpp I was wondering if I should add new pages for code of conduct and changelog, let me know your opinions on it.

Saransh-cpp commented 6 months ago

Yes, but maybe in another PR?

Naman-Priyadarshi commented 6 months ago

Yeah sure, I'll open a new PR after this is merged.

github-actions[bot] commented 6 months ago

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

The release is available on:

Your semantic-release bot :package::rocket: