Contributing file updates
See original GitHub issueSummary
After PR #354 there were a few small changes that need to be made, and some additions requested by @tesla809. The list of updates are below.
- fix local repo reference to use
Corona-tracker
versusCOVID-19-TRACKER
(the latter was the name I used for my fork, didn’t catch it when putting things together) - add more info on using git branches
- add more info on clean commit messages
- add more info on what to do when things go wonky (technical term)
- rebasing against upstream master
- resetting against upstream master (fresh start)
- force pushing changes to origin
- review file for any duplicate content
Motivation
The additional information above would fit well with the Forking the Repo and Updating a Forked Repo, possibly adding a third outline item for “I broke my repo, now what?” or similar.
Describe alternatives you’ve considered
None at this time! Trying to find the balance between short and sweet and overly informative. ℹ️
Additional context
None.
Issue Analytics
- State:
- Created 3 years ago
- Comments:5 (5 by maintainers)
Top Results From Across the Web
Setting guidelines for repository contributors - GitHub Docs
To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, docs ,...
Read more >How to Build a CONTRIBUTING.md
A CONTRIBUTING.md file, in your open source repository or site, provides potential project contributors with a short guide to how they can help...
Read more >Contributing Guidelines | The GitHub Blog
It explains how a participant should do things like format code, test fixes, and submit patches. Here is… Oftentimes open source projects place ......
Read more >Automatically update your CONTRIBUTORS file with this ...
This GitHub Action updates a CONTRIBUTORS file with the top contributors from the specified project, pulling contents from the GitHub API.
Read more >Get Others Involved in Your Project with a CONTRIBUTING ...
Make sure that your CONTRIBUTING file is located in your repository root, docs folder, or .github folder. GitHub supports CONTRIBUTING files ...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Some items are complete and I reflected that in the checkboxes above. After looking over the updates again and some changes submitted by @tesla809, I’d like to pause on completing this before initial launch and ask some bigger questions, mainly toward content duplication and moving some items to their own files. This became quite a large CONTRIBUTING file!
For example, Updating a Forked Repo, Git Contribution Workflow, and Updating the Repo have very similar content about fetching and merging upstream master repo in slightly different contexts.
Here were some ideas I had reading through today:
esc
+:x
in there!)I can take a deeper dive into this later on but didn’t want it to be a blocker in any way, I am curious to know your thoughts, and if something needs immediate update feel free to ping me.
Maybe we should have the PR you have out now close this issue, and then take these suggestions and write out newer, more parallelizable issues?