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.

Sign up for GitHub

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

Jump to bottom

Documentation Guidelines, Contributing Guidelines, and GitHub Discussions #26

Merged
merged 5 commits into from
Aug 23, 2023
Merged

Documentation Guidelines, Contributing Guidelines, and GitHub Discussions #26

merged 5 commits into from
Aug 23, 2023

Conversation

PSchmiedmayer
Copy link
Member

@PSchmiedmayer PSchmiedmayer commented Aug 23, 2023 •
edited
Loading

Documentation Guidelines, Contributing Guidelines, and GitHub Discussions

♻️ 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

💡 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:

@PSchmiedmayer PSchmiedmayer self-assigned this Aug 23, 2023
@PSchmiedmayer PSchmiedmayer added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 23, 2023
@PSchmiedmayer PSchmiedmayer merged commit c4504be into main Aug 23, 2023
1 check passed
@PSchmiedmayer PSchmiedmayer deleted the documentationGuidlines branch August 23, 2023 23:09
@PSchmiedmayer PSchmiedmayer changed the title Add Documentation Guidelines Documentation Guidelines, Contributing Guidelines, and GitHub Discussions Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@PSchmiedmayer PSchmiedmayer

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Project Planning
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@PSchmiedmayer