-
-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: simplify contributing page #267
Comments
Edited the issue description around the goal of simplifying the page. Removed text that should go into separate issues. |
The complexity is small since it doesn't modify most of the contents of the newly created pages. That will be done in future issues. |
Updated issue tasks to split The problem with this issue is it splits up CONTRIBUTING.md into smaller files, and any other PR changing CONTRIBUTING.md is going to get a massive conflict with it. I see PR #370 having one of those changes, so I will create this issue's PR when that's merged. |
I need to create the PR from my changes. Need an hour's time. I have the changes done but I was trying to figure out if there's a way to do the commits so it's easier for other people to merge changes from before my changes, because my change splits 1 file into 5-6 files. I tried it and the changes is about 100% of the files. If I don't figure out a way with the git diff strategies, I'll just create the PR from what I have. |
I created a guide for manually applying changes to a different files, so that if someone made changes to the old long CONTRIBUTING.md, they can manually but successfully apply those changes as patch files when merging. Link |
I reverted some code that removed the 3-column layout, which is not part of this issue, and remade the screenshots. The PR is ready for review again. |
Overview
We need contributing docs more suitable for contributors of our project that should already know the basics. The main page should be kept simple with links to more detailed explanations. A short but useful contributor intro to the project will make it more accessible.
Action Items
contributing
folder indocs/
to hold contributing pagescontributing/
CONTRIBUTING.md
fromdocs/contributing/index.md
CONTRIBUTING.md
with short description and link tocontributing/index.md
contributing/index.md
sections with short descriptions and links to individual pagesInstructions
The text was updated successfully, but these errors were encountered: