search

PretendoNetwork / .github

Information on the WIP Custom Nintendo WiiU/3DS/2DS server and service replacements
GNU Affero General Public License v3.0
922 stars 21 forks source link

fix: update contributing guide link in README #78

Closed christophe-asselin closed 1 week ago

christophe-asselin commented 1 week ago

The link to the CONTRIBUTING.md in README.md is broken.

jonbarrow commented 1 week ago

While the changes here are technically correct, I'm not sure it's worth merging them. This is (somewhat) intentional. The current README is going to be trashed and replaced, which is why no updates have happened with it. I'm not sure it's worth maintaining a version of the README which is going to just be thrown away.

This is mentioned here in this issue https://github.com/PretendoNetwork/.github/issues/73, and is why we have the PR templates and approved issues system (which was not followed here).

christophe-asselin commented 1 week ago

Got it, it's just a little confusing as a new potential contributor... If the README is outdated, it might be beneficial to have a disclaimer at the top?

jonbarrow commented 1 week ago

I do understand it may have been confusing, however when opening the PR you were presented with the following:

Screenshot from 2024-06-26 10-51-49

This lays out the template for making PRs (which was not followed here), and gives you various instructions on making sure the PR is valid. Even without a working link in the README, this template has all the information you would need and does have a working link to the contribution guide to be read. It directly mentions the "approved issues" system we have in place, which if followed would have showed you the existing issue related to the README.

it might be beneficial to have a disclaimer at the top?

If any changes to the README are to be made they might as well complete https://github.com/PretendoNetwork/.github/issues/73, in my opinion. I'm not sure there's much use maintaining the README as-is? It's a simple task (marked as "beginner" on our task list), just not one that's been completed yet due to more important issues taking priority.

This PR could be reused for this purpose, if you'd like.