[Discussion] Updating CONTRIBUTING.md
See original GitHub issueNote: This is not a issue actually but more of a open discussion regarding a contributing workflow.
I have been doing some Rnd on Fork-and-Branch Git Workflow and also on other sites and found that the basic workflow for adding a new feature to a forked repo is like:-
- Fork a GitHub repository. [Same as in our CONTRIBUTING.md ✔️ ]
- Clone the forked repository to your local system. ✔️
- Create a feature branch in which to place your changes. ❌
- Make your changes to the new branch. [Currently done on master ✔️ ]
- Commit the changes to the branch. [Currently done on master ✔️ ]
- Push the branch to GitHub. ✔️
- Open a pull request from the new branch to the original repo. ✔️
So, do you think it is a best practice to always make the new feature or experimental changes on a new branch? Should we update our CONTRIBUTING.md
to reflect that too?
Regards!
Issue Analytics
- State:
- Created 6 years ago
- Comments:5 (3 by maintainers)
Top Results From Across the Web
Update CONTRIBUTING.md with regards to discussion ...
Affects: N/A The Discuss section in Contributing to the Spring Framework ... Update CONTRIBUTING.md with regards to discussion forums #27509.
Read more >How to fill out the CONTRIBUTING.md template
This is an excellent way to have participants begin making contributions. Adding productive contributors should be a key objective of any ...
Read more >Contributing to pkgdown
Contributing to pkgdown. Source: .github/CONTRIBUTING.md. This document outlines how to propose a change to pkgdown. For more detailed info about ...
Read more >Contribute
To contribute updates to the original version, you may either: ... a pull request that will be reviewed to discuss and make a...
Read more >Contributing Guide
Also, it is useful to know that you do not need to create a new branch if you are going to work on...
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
@palashmon Ooh that makes so much sense! I’ve deleted and forks again in the past 😅
Hi @SaraVieira 😁
I think this is an useful addition
@nitin42, good idea! splitting into multiple sections would be super useful too!
+1, the example @palashmon gave makes sense, and frankly, seems like something that people might overlook easily.