Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upreadme.rst Improvement #5761
readme.rst Improvement #5761
Comments
|
The cynic in me says that if one can't find their way into contributing.md, then they likely don't have what it takes to contribute anything of value. Not least because contributing.md is automatically linked by GitHub in the "New issue" form. On the other hand, it can't hurt, but there's also a tiny issue with linking to the file - we'd have to make a hard link (i.e. absolute URL, not relative) to it, which includes the branch in it and that's a bit wonky when the 3.1-stable branch links to develop for no apparent reason (and you can be sure nobody will bother correcting that after each merge). @jim-parry What do you think? |
|
I'll say I came here looking to check out a few tickets to fill some coding time for my goals, and was a little disappointed to not easily find documentation on the home readme to check out while I forked the repo over. Good developers can find documentation, true; however, I don't think we should have to hunt for it either when volunteering our time to assist. |
Issue bcit-ci#5761 asked for an imporovment to this document. This is very simple tweak. However I think it accomplishes the goal for everyone Without any bloating of the main readme.
Problem Description: No instruction of how to contribute in readme.rst. First time users will probably want to see information of how to contribute (which includes how to set up environment, communicate, and submit changes, etc.).
Solution Description: Add a contributing section in readme.rst with general contributing information, and include a link to file "contributing.md" (https://github.com/bcit-ci/CodeIgniter/blob/develop/contributing.md).