Suggestion: mention canary/master branch system in the readme
See original GitHub issue- I have searched the issues of this repository and believe that this is not a duplicate.
Next.js breaks from GitHub convention by using canary
as the default branch. I’m sure there are great reasons for this, but I think it’s important to flag it up in the readme, and perhaps even add navigation-style links at the top to switch between the ‘master’ and ‘canary’ readmes. I’d be happy to add this if you’re open to it.
This would help new users to avoid getting confused reading the wrong docs. It would also help users like me who want to get involved but who get put off by not being able to answer simple questions quickly and confidently, like which branch should I pull from, or PR into, etc.
Issue Analytics
- State:
- Created 5 years ago
- Reactions:17
- Comments:5 (2 by maintainers)
Top Results From Across the Web
mention canary/master branch system in the readme ... - GitHub
Next.js breaks from GitHub convention by using canary as the default branch. I'm sure there are great reasons for this, but I think...
Read more >Readme.md from "master" branch as opposed to the default ...
We use "dev" as our default branch. I added a README.md file today, but it doesn't display on the project page. When I...
Read more >Git - Branches in a Nutshell - Git SCM
The default branch name in Git is master . As you start making commits, you're given a master branch that points to the...
Read more >Tutorial Git and GitHub - 7. Branching & Merging - 2020
Our GitHub now has only one branch which is master since another branch fix1 has been deleted. Now, we need to push our...
Read more >markdown - Referencing current branch in github readme.md
Simply display all the branches and their respective TravisCI badges. If you have only two or three branches, that could be enough. Share....
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
I second that. Spent the whole afternoon trying to make a custom
<App />
work, because I read it in the documentation, only to find that it’s not out yet, despite being properly documented on the readme file.Only after seeing
canary
mentioned in one of the issues related to the feature I understood what was going on. 😞Exactly, the upcoming stable release will be 7.0.0 as we’ve upgraded webpack and there are a few other breaking changes.