Skip to content
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

Links need to be fixed in CONTRIBUTING.md #154

Closed
tobyhodges opened this issue Jun 2, 2023 · 6 comments · Fixed by #155
Closed

Links need to be fixed in CONTRIBUTING.md #154

tobyhodges opened this issue Jun 2, 2023 · 6 comments · Fixed by #155

Comments

@tobyhodges
Copy link
Member

The Contributing Guide, CONTRIBUTING.md, contains two links with URLs that should be updated:

  1. the How to Contribute to an Open Source Project on GitHub link leads to a 404 and should be updated to link to https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
  2. the [repo] link reference currently points to a placeholder URL (https://example.com/FIXME) and should be updated to point to the source repository for the lesson (i.e. this GitHub repository).

The Contributing Guide is one of the files that is unique to each repository - to allow for individual lesson projects to define their own guidance for contributors - so unfortunately this is not an issue that can be fixed centrally e.g. by updating the template files in the lesson infrastructure. Instead the file must be updated in the individual lesson repositories themselves.

@JCSzamosi
Copy link
Contributor

Thanks for opening this, @tobyhodges. I'll do a pull request today to fix it. Any objection to me fixing both in a single PR?

@JCSzamosi
Copy link
Contributor

While I'm looking at this, I notice that the link labelled "creating an issue" links not to the issues tab, but to a list of existing, open Carpentries issues. This seems confusing to me, since it doesn't actually show the reader how to create new issues. I wonder if this list should be linked from the third bullet (creating a pull request), and a link to the issues tab added to the second bullet?

@tobyhodges
Copy link
Member Author

tobyhodges commented Jun 5, 2023 via email

@tobyhodges
Copy link
Member Author

And I agree with your comment about the link to the Help Wanted Issues listing. If you'd like to also adjust that wording, please do - if you want to do it in the lesson infrastructure templates for this file, so that the change is reflected in all future repositories as well, that would be even better

@JCSzamosi
Copy link
Contributor

That sounds like a good plan. Do I need to include that third change in this PR as well, or does it suffice to do it in the infra template? It seems like it will need to be changed piecemeal for existing repositories, yes?

@tobyhodges
Copy link
Member Author

I'm afraid that's right, yes.

This was referenced Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants