Enhance the contributing guide in online doc #123
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add sections and reorganize into - setting up dev environment - installation from source in dev mode - local build of the docs - running tests - guide lines when coding - code linters - notebooks convention - adding tests - pull request process
f3357c8 to
7f6d61c
Compare
dbarbier
approved these changes
Nov 26, 2021
docs/contribute.md
Outdated
| - [check the documentation locally](#building-the-docs-locally) if you modified it | ||
| - check you respect the coding styles by [running linters](#coding-style-and-code-linting) | ||
|
|
||
| I you do not, you will still be able to see the status of your PR as CI will do that checks for you. |
There was a problem hiding this comment.
2 typos: If ... these checks for you
docs/contribute.md
Outdated
|
|
||
| - Fork the repository on github. | ||
| - Clone your fork on your computer. | ||
| - Create a branch with a self-explanatory branch, e.g. `xx/add-solver-crazyalgoname` where "xx" stands for your initials, |
There was a problem hiding this comment.
External contributors do not need to follow this naming scheme, they can use their master branch if they want.
docs/contribute.md
Outdated
| - having a separate commit to reformat previous existing code if necessary | ||
| - rewritting commit messages so that it explains the changes made and why, the "how" part being explained by the code itself | ||
| (see this [post](https://chris.beams.io/posts/git-commit/) about what a commit message should and should not contain) | ||
| - rebasing on main repository main branch if it diverged too much by the time you finished |
There was a problem hiding this comment.
upstream repository's master branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add sections and reorganize into:
You can preview the resulting page here (github markdown interpreting). Or have a complete view of resulting documentation by downloading the "doc" artifact from the "Build scikit-decide" action triggered by this PR , and then:
mkdir testdoc cd testdoc unzip path/to/doc.zip -d scikit-decide python -m http.server