-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Contributor guide update #787
Conversation
Note - we haven't really been following a specific approach to pull request etiquette, but we realised it would be better to adopt an agreed approach going forward |
Thanks @tennlee! The given instructions/suggestions in the PR etiquette section sound good and reasonable to me. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pull request etiquette section looks look to me! Thanks for adding that.
I have one suggestion on the forking section
1. First (i.e. **before** cloning the `scores` repository) create your own fork using the GitHub web user interface. | ||
2. Clone **your fork**. (Do not clone github.com/nci/scores). | ||
3. Immediately create a new local branch, with a command such as `git checkout -b branch_name`. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider a line to periodically sync your fork
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It could possibly fit into the section just below
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have added a commit to the PR to add some information on this to the PR workflow. Let me know if that seems sufficient.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good - In addition it may be good to encourage people to sync their fork before they create a new feature branch to minimise the amount of rebasing etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While that's good advice, I feel like it may be stepping over into a more detailed guide that we don't really have the ability to provide. Ideally, it would be nice to link to some general resource that hopefully already exist out there. Feel free to do some looking around and raise a new PR if you find some good ones.
Hi everyone. I am going to merge this PR so we can get it into the develop branch and included into the next release. If anyone leaves any more comments here, I will respond to and consider them. Otherwise, feel free to raise a new issue or put up a PR with any specific suggestions that you might have. Everyone should very much feel free to put up PRs at any stage with any kind of suggested improvement. |
* Update contributor guide to include more information on forking and branch management
* Update contributor guide to include more information on forking and branch management
Hi all,
I would like to update the Contributing Guide to reflect lessons learned from the recent sprints at PyCon AU. I am hoping these updates will better support first-time contributors to
scores
. Additionally, the guide now makes it clearer how to handle interactions on pull requests generally.I am proposing adding two sections:
scores
for the First TimeI am also proposing updating the following section:
@arshiaar, @lbluett , @JinghanFu, @techdragon, @AJTheDataGuy - your feedback would be welcome on whether the updates would have helped you onboard into
scores
development.Feedback from @nicholasloveday, @rob-taggart, @reza-armuei, @mareecarroll and @Steph-Chong would be welcome on whether the section on pull request etiquette seems appropriate for first-time and existing contributors alike.
Thanks all.