-
Notifications
You must be signed in to change notification settings - Fork 2k
Closed
Description
Which version of the book is affected?
The version that's hosted on GitHub.
Present on master
.
Describe the bug:
The documentation for contributing is split between the landing page README.asc and the CONTRIBUTING.md
Steps to reproduce:
- Go to https://github.com/progit/progit2.
- A contributor reads the section that displays the README.asc
- But then also the contributor needs to click trough to another guide, to find out how to really contribute.
Expected behavior:
- Go to https://github.com/progit/progit2
- The README.asc contains everything a contributor needs to get started, so the content of README.asc and CONTRIBUTING.md are merged.
Screenshots:
Additional context:
I noticed the split between the files when working on the text of the contributing guide in this PR: #1477.
Discussion:
What is the reason that the content is spread around in two files, instead of merged into one README?
If you want to merge the content, I'll make a pull-request that merges the content together.
Metadata
Metadata
Assignees
Labels
No labels