Skip to content

"Contributing" doc #174

Open
Open
@VirtualDOMinic

Description

@VirtualDOMinic

Relates to #138

We currently have some dev instructions in the README.md, but - given that the CoC (#138) is typically included as part of a CONTRIBUTING.md (see Formidable's own Victory and Spectacle repos) - and that we might want to add more contribution instructions (e.g. commit message and branch name conventions), I think we should choose between:

  • Adding a CONTRIBUTING.md with contribution instructions
  • Actively deciding to stick to having everything in the README.md (perhaps with a contents list at the top to make it nicer to use as the file grows)

Preferences?

Activity

VirtualDOMinic

VirtualDOMinic commented on Jan 13, 2020

@VirtualDOMinic
ContributorAuthor

See linked PR for my preferred implementation (option 1: adding a CONTRIBUTING.md)

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    "Contributing" doc · Issue #174 · FormidableLabs/runpkg