doc: highlight pre-requisties and bubble up related sections #613
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Member
| Hey @mrchief I can merge this now. Sorry for the delay. If you can just resolve the conflicts then I will press the button. Again thanks for the contribution.
|
Contributor Author
| I tried resolving using GitHub UI and I don't have high confidence in doing a correct merge. I need to dig deeper into this. |
# Conflicts: # README.md
Contributor Author
| @jimthedev Please check now and hit the button before it's too late again! 😄 |
Contributor Author
| @jimthedev gentle reminder |
jimthedev approved these changes Jul 17, 2019
| 🎉 This PR is included in version 3.1.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Fixes #558
@jimthedev 644eb50 highlights the need for making the repo commitizen friendly. The remaining 2 commits are to bring related sections together. The rough outline now is
The last 2 edits were not necessary strictly speaking but I think it helps in bringing a top-down flow of topics that belong together.
E.g., after doing the local setup, one can read about the global setup. Next, once you're done with single projects, one may be interested in setting up multi-repo projects. "Adapters" seem the natural fit as a next topic. "Retrying failed commits" seemed like an update that came later with certain version & up so it is after Adapters.
Keeping up with this, we find that there are no more topics for "Commitizen for project contributors", so we start with "Commitizen for project maintainers". And then we talk about going further and other important topics.
The idea is easy skimming of the readme starting with the most important parts first and gradually taking the reader to advanced & deeper topics.
Let me know your thoughts.