The-Strategy-Unit / The-Strategy-Unit/data_science
How to write a good pull request / do good code review
Open
Nobody has claimed this yet.
session: C&C ☕
- Dominant language
- Jupyter Notebook
- Stars
- 11
- Forks
- 5
- Avg merge
- 5h 34m
- Merged PRs (30d)
- 1
Description
- What are best practices
- What are some bad things to do?
- We could look at Jack’s approach, for example (Matt)
- @francisbarton attended a session on Kinder Code Review and had some interesting takeaways to share
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No repository file or entry point is named. Start by reviewing Jack’s approach and the Kinder Code Review takeaways referenced in the issue, then define the guide’s scope around good practices and common pitfalls. Done means the repository has an agreed, actionable guide for writing pull requests and conducting code reviews.
Written by the indexing model from the issue text.
Assessment
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100