Structure the CONTRIBUTING guide to define sprint tasks #311
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
lwasser
reviewed
Jul 3, 2024
|
|
||
| This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/html`. | ||
| The site can then be viewed locally by opening the top level `index.html` in your web browser. The exact location of this file will depend on you system, but the output of the following command could be copied into an address bar | ||
| *__TODO__: This section should show a beginner user how to fork a repository in GitHub.* |
There was a problem hiding this comment.
This is great - we can link to this lesson here!. i plan to bring that lesson over to our tutorials at some point!
lwasser
reviewed
Jul 3, 2024
| ``` | ||
| python -m nox -s docs-live | ||
| ``` | ||
| *__TODO__: This section should show how to use the GitHub interface to edit and previewing a Markdown file.* |
There was a problem hiding this comment.
let's make this another help-wanted task for our sprint :)
lwasser
approved these changes
Jul 3, 2024
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This PR prepares the CONTRIBUTING guide for the SciPy development sprints. See this issue #310.
What was done
I added an initial structure with placeholders to breakdown the task of updating the document into smaller tasks that can be tackled by beginner contributors during the sprint.
The issue Update the Contributors Guide can be used to coordinate the work, new contributors can choose parts of the file to work on while making sure that work is not duplicated.