Documentation about contributing to Stardis #247
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
RyanGroneck
changed the title
|
I built the new documentation locally, and everything seemed right and proper |
| @@ -0,0 +1,125 @@ | |||
| { | |||
There was a problem hiding this comment.
| @@ -0,0 +1,159 @@ | |||
| { | |||
There was a problem hiding this comment.
| @@ -0,0 +1,159 @@ | |||
| { | |||
There was a problem hiding this comment.
Maybe a comment at the beginning saying, "This takes you through contributing using WSL and VScode with my personal installations."
Also mention that this assumes you have already forked stardis.
Reply via ReviewNB
| @@ -0,0 +1,159 @@ | |||
| { | |||
There was a problem hiding this comment.
Maybe not bash specifically, maybe just say command line or terminal
Also you probably don't need to mention the OS.
Reply via ReviewNB
| @@ -0,0 +1,159 @@ | |||
| { | |||
There was a problem hiding this comment.
Probably we don't need to complain about the standard name for every github repository main branch
"This way, when you make the Pull request to apply that change, the reviewers know exactly what your change does, and the proccess goes smoothly."
This is true but somewhat independent of making new branches for each feature. Probably instead you can talk about how this keeps things tidy and easier to review. When you open the PR we can focus on perfecting code that implements a single feature, or can revert a single commit later if it does something wrong.
Reply via ReviewNB
| @@ -0,0 +1,159 @@ | |||
| { | |||
There was a problem hiding this comment.
hearts -> heart's
Careful about assuming the person is using specifically vscode on windows
Reply via ReviewNB
| @@ -0,0 +1,159 @@ | |||
| { | |||
There was a problem hiding this comment.
git add -A adds all changed files to the PR. You might want to add that to the end of 1), and mention that you can also add individual files by name.
I'd also add a line here saying you can do git status to see which files are staged for for the commit, and which files are changed but are not part of it.
Also at the end of this whole notebook, I think it's worth mentioning that the vast majority of pull requests get feedback and are iterated upon before they're merged into the code, and to not be discouraged if people request changes. This is a normal part of the code development process.
Reply via ReviewNB
|
Having looked more, I do think removing the "starting from scratch" notebook from this PR still makes the most sense. |
📝 Description
Type: 📝
documentationAdding documentation for guided instructions on setting up Stardis for would-be developers, and how to make your first Pull Request. This PR is still a work in progress until otherwise indicated.
Also, link issues affected by this pull request by using the keywords:
close,closes,closed,fix,fixes,fixed,resolve,resolvesorresolved.📌 Resources
Examples, notebooks, and links to useful references.
🚦 Testing
How did you test these changes?
☑️ Checklist
build_docslabel