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

Align docs to OSC governance #938

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Align docs to OSC governance #938

wants to merge 1 commit into from

Conversation

Ranchhand87
Copy link

Changelog

- description: |
    <Update documentation to align with Governance Policy> If needed.

# uncomment types applicable to the change:
  type:
  
  # - documentation  # change in code docs, haddocks...

Context

https://committees.docs.intersectmbo.org/intersect-open-source-committee/policies/governance/documentation

How to trust this PR

Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.

Checklist

  • [ Y ] Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • [ Y ] Self-reviewed the diff

@Ranchhand87 Ranchhand87 added the documentation Improvements or additions to documentation label Oct 15, 2024
@CarlosLopezDeLara
Copy link
Contributor

@Ranchhand87

When creating a PRs, please make sure you follow this directive:

# uncomment types applicable to the change:

For example:

# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - refactoring    # QoL changes
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  - documentation  # change in code docs, haddocks...

This will help the automation that generates changelogs to work correctly.

@carbolymer
Copy link
Contributor

Thanks. I've signed the commits and pushed with force.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants