Skip to content
This repository was archived by the owner on Oct 9, 2024. It is now read-only.
This repository was archived by the owner on Oct 9, 2024. It is now read-only.

Add contributing resources to template and core project #15

@abuxton

Description

@abuxton
  • it would be awesome to have a good, CONTRIBUTING.MD
  • go is awkward to fork and branch due to mod file management this would be nice documented (see https://gist.github.com/abuxton/e337d3c8fba5693f7b65c926f5442a80)
    move core of README.MD to CONTRIBUTING.MD alongside that guidance
  • how do you run the core service to see the source work guidance
  • what is nats? is it needed if so getting started link for guidance
  • add a .vscode folder with relevant extensions, such that a workspace will self-configure as .vscode methodology (all project repos)
    • add a snippet for source api-onbject documentation (what is it, fins, get )
  • what is srcman, is it required, provide getting started link for contributors
  • update current README.md so it is actually as an example of the desired readme or add link to entry file in /docs folder
  • add .github/* community health files to template https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file allowing structure for pull request etc (this should be added to all repos)
  • if there is a fast/helper way to generate docs, add to contributor file

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions