StanfordSpezi / .github

Stanford Spezi

1 stars 2 forks source link

Documentation Guidelines, Contributing Guidelines, and GitHub Discussions #26

Closed PSchmiedmayer closed 1 year ago

PSchmiedmayer commented 1 year ago

Documentation Guidelines, Contributing Guidelines, and GitHub Discussions

:recycle: Current situation & Problem

Documentation across Spezi Modules is currently not following a shared format and standard
PR notes are too long and often not filled out by developers
The Contributing Guidelines could be more clearer

:bulb: Proposed solution

Adds clear instructions on how documentation for a Spezi Module must look like
Simplifies the PR template.
Improves the Contributing Guidelines.
Ensures a more structured GitHub Discussions setup

Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

[x] I agree to follow the Code of Conduct and Contributing Guidelines.