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

Replace README.md with instructions for contributors. #313

Open
gheber opened this issue Sep 3, 2024 · 3 comments
Open

Replace README.md with instructions for contributors. #313

gheber opened this issue Sep 3, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@gheber
Copy link
Member

gheber commented Sep 3, 2024

Let's use the README.md file to document the DOs and DON'Ts for this project. Let's also tell people how to test the changes they've made before creating a PR.

@gheber gheber added the documentation Improvements or additions to documentation label Sep 3, 2024
@loricooperhdf
Copy link
Collaborator

@gheber See a first stab of this at https://github.com/loricooperhdf/HDFGroup.github.io/blob/master/README.md

Not at all sure if this is what you were looking for--how do you want them to test changes? Also since this duplicated content of index.md I want to confirm that this won't change the text on the homepage.

@loricooperhdf loricooperhdf self-assigned this Sep 30, 2024
@lkurz
Copy link
Collaborator

lkurz commented Sep 30, 2024

Also since this duplicated content of index.md I want to confirm that this won't change the text on the homepage.

The README.md is for the REPO. The index.md is for the SITE homepage.
They are independent of each other, except in the case when there is no index.md file, then github-pages uses the README.md, but the SUPPORT (ie non-github-pages) site would have an empty body for the homepage.

Set up GitHub pages on your fork to test your changes before submitting.

Instead developers can also work from Githb Codespaces or use a container with (or without) VSCode on a local dev machine. More details to come pertaining to this scenario.

@lkurz
Copy link
Collaborator

lkurz commented Oct 3, 2024

Lori, can you PR this to a branch on GHIO repo?
Also can we remove all the completed PR branches to clean up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants