Skip to content

docs: updating README and GH wiki with latest contribution practices/guide #43

@JustinZhang17

Description

@JustinZhang17

Context

Currently the README and Wiki do not show the most updated contribution guidelines for this project, naming branches, how to write issues, and templates used. Please Update the README so it links to the WIKI with the contribution guide. We do not want the README cluttered with too much text.

Furthermore, the current documented file structure does not match the true file structure. The currently documented file structure on the README only shows a file structure for a controller, but the new file structure should be designed and documented for a controller and a scheduler.

TODO

  • naming branches guideline
  • document the project report on the Github Wiki
  • add a code of conduct
  • move the git branching strategy, branch naming convention, Commit Messages, Issue structure, and Pull request structure into the wiki and link it on the README.md (rather than having it sit on the README.md as one long doc)
  • add a Contributing and Security Guide

Reference: https://github.com/gccloudone/oss-templates?tab=readme-ov-file
Reference: StatCan/namespace-cleaner#55

Expected Outcome

Have a project that is better documented and lives up to modern OSS standards

PR: #97

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions