Skip to content

DOC: Add a Contributing and Contributors Readme #2

Description

@JosephDYork

Create a Readme that outlines a quickstart for Open source contributors. This should include the following:

For the Contributing Readme:

  • Setting up a proper python dev environment, using Python's built in virtual environment modules. This should include package and development prerequisites. Including formatters, linters, and type checking packages.
  • Expectations about how issues are to be opened and handled. Tags, issue tracking, and linking PR's.
  • Expectations about how contributions are handled. Forking the repo, opening a PR, and attaching all PR's to existing issues.

For the Contributors Readme:

  • A list of all package committers with at least one merged commit, their github handles, and if applicable their name or associated company.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Version 1.0 IssueTicket is blocking the version 1 release of EqLinkdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions