Skip to content

Move .github/CONTRIBUTING.md to CONTRIBUTING.md and move relevant README content there #1991

@gaurav

Description

@gaurav

The current README.md is primarily information intended for contributors to this website, while the current .github/CONTRIBUTING.md is essentially empty.

I think we're missing an opportunity to let people who randomly find this repo on GitHub or who want to perform some other task (e.g. searching for events/people/WG, look through the organizational history, etc) learn more about what US-RSE is and where to find out more about it, as well as a good place to recognize all the contributors. I think that's what should be in README.md.

I also propose that we move CONTRIBUTING.md from the GitHub specific ./.github/CONTRIBUTING.md to the standard CONTRIBUTING.md in the repo root, and then move all the contribution-specific information there. Apart from being a more GitHub-independent way of organizing this file, I think it will be easier for contributors to refer to the instructions in this way. GitHub also displays "Remember, contributions to this repository should follow its contributing guidelines." at the bottom of every issue, so having something useful to link it from there would be useful.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions