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.

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

Document content-specific contribution guidelines #8

Open
platten opened this issue Jun 16, 2021 · 0 comments
Open

Document content-specific contribution guidelines #8

platten opened this issue Jun 16, 2021 · 0 comments
Labels
area/community Relates to all community activities area/documentation Related to all activities around documentation area/hub-manifests Relates to Hub manifests enhancement New feature or request needs-triage Relates to issues that should be refined

Comments

@platten
Copy link
Contributor

platten commented Jun 16, 2021

Description

It would be helpful to have the content-specific contribution guidelines, which could discuss the requirements, review process and strategy around content governance & lifecycle.

AC

  • Document best practices for storing and creating Hub manifests:
    • Hierarchy, e.g. prefer cap.interface.database.postgresql instead of cap.interface.postgres
    • How populator stores data e.g. generated path. Currently, they are calculated from dir structure (hierarchy).
    • How to deal with multiple revisions for the same Action. Currently, we use file names, e.g. install-0.0.1, install-0.2.1
  • Document review process and strategy around content governance & lifecycle.
  • To discuss: Apart from CONTRIBUTING.md, publish it also on website in Community section

Reason

"Consistent code is easier to maintain, is easier to rationalize, requires less cognitive overhead, and is easier to migrate or update as new conventions emerge or classes of bugs are fixed."

  • It's easier for us to review community PRs.
  • External contributors don't need to figure out the correct approach each time they create manifests.
  • There are no defined rules how the Hub content should be stored, which might be confusing for content developers.
  • Transparency

Use cases

  • Content Developer - knows how to create quality, good content.
@pkosiec pkosiec transferred this issue from capactio/website Jul 14, 2021
@pkosiec pkosiec added the needs-triage Relates to issues that should be refined label Jul 16, 2021
@pkosiec pkosiec changed the title Content-specific contribution guidelines Document content-specific contribution guidelines Sep 17, 2021
@pkosiec pkosiec added area/community Relates to all community activities area/hub-manifests Relates to Hub manifests enhancement New feature or request labels Sep 17, 2021
@mszostok mszostok added the area/documentation Related to all activities around documentation label Nov 15, 2021
@mszostok mszostok removed the size/XS label Dec 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/community Relates to all community activities area/documentation Related to all activities around documentation area/hub-manifests Relates to Hub manifests enhancement New feature or request needs-triage Relates to issues that should be refined
Projects
None yet
Development

No branches or pull requests

3 participants