development process updates#82
Conversation
| For more information, see [](submitting-pr.md). | ||
| ``` | ||
|
|
||
| - Once you've completed the work, submit a draft pull request to the repository. |
There was a problem hiding this comment.
We can mention here that draft is when it's still work in progress. Need to mark ready for review when work is completed.
There was a problem hiding this comment.
Few typos here:
opem, clicck
|
Added some comments. Do you think it would help if there's a simple flowchart diagram to help understand which tutorial to refer in which scenario? common scenarios maybe |
| you can choose one that you're interested in working on. | ||
| ## 1. Getting issue assigned | ||
|
|
||
| The project's maintainers may assign you an issue, or you can choose one that you're |
There was a problem hiding this comment.
or you can -> or you can (double space)
|
|
||
| Check the logs and fix them (see the [troubleshooting](troubleshooting.md) guide | ||
| for tips). If you're unable to fix the issues after spending some time on them. You | ||
| can message us on Slack so we can help you. |
There was a problem hiding this comment.
If you're unable to fix the issues after spending some time on them. You
can message us on Slack so we can help you.
I think it should be one sentence
|
|
||
| Ensure there are no [merge conflicts](#fixing-merge-conflicts). | ||
|
|
||
| If all the test pass and there are no merge conflicts, you can [request a review](#requesting-a-review). |
There was a problem hiding this comment.
conflicts, you can -> conflicts, you can (double space)
|
thanks for the feedback, addressed all the comments!
@neelasha23: we have some quick access links in the home page. do you think this can help? Or are you thinking that we can include an actual diagram (perhaps in the outline section?). adding the diagram would be simple with mermaid: https://mermaid.js.org/intro/ |
Yes if it's not too much of a task maybe a visual chart would be easier and quicker to understand. Also, I can't see resolve conversation buttons anywhere |
|
@neelasha23 thanks for the heads up on the "resolve conversation" button. I fixed github permissions (I'll add a little note so people can notify us if they're lacking permissions). please resolve the conversations if you're ok with the changes. I'll open a new issue with the flowchart |
neelasha23
left a comment
neelasha23
left a comment
There was a problem hiding this comment.
Added a comment on typos. Looks good otherwise!
3 participants
updated the contribution guidelines based on feedback I've heard from the team
📚 Documentation preview 📚: https://ploomber-contributing--82.org.readthedocs.build/en/82/