Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the contribution guide in the documentation #171

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

felixchalumeau
Copy link
Collaborator

@felixchalumeau felixchalumeau commented Jan 23, 2024

Related issues: #170

Adding a few sentences to better explain the contribution process. In particular, made it clear that one needs to start by opening a github issue, then fork the repository (unless having permission to branch inside the main project), and request to merge to develop once the contribution is ready.

Checks

  • a clear description of the PR has been added
  • sufficient tests have been written
  • relevant section added to the documentation
  • example notebook added to the repo
  • clean docstrings and comments have been written
  • if any issue/observation has been discovered, a new issue has been opened

Future improvements

n/a

@felixchalumeau felixchalumeau linked an issue Jan 23, 2024 that may be closed by this pull request
@felixchalumeau felixchalumeau changed the base branch from main to develop January 23, 2024 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Small refinement of the contribution guide
1 participant