Skip to content

Conversation

@hoangndst
Copy link
Member

@hoangndst hoangndst commented May 16, 2025

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

  • N
  • Y

fix #13

2. What is the scope of this PR (e.g. component or file name):

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

This pull request adds a comprehensive CONTRIBUTING.md file to the kusion-backstage-plugin repository. It provides guidelines for contributing, coding standards, and the release process, along with instructions for setting up the development environment and creating changesets.

Changeset and Release Process:

  • Explained when and how to create changesets for versioning and changelog updates, with links to relevant documentation.
  • Documented the release process, including how changeset files trigger version bumps and package publishing to npm.

API Reports:

  • Added instructions on generating and updating API Reports using API Extractor for plugins/packages, ensuring API documentation is up-to-date.
  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Other

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

  • N
  • Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

  • Unit test
  • Integration test
  • Benchmark (add benchmark stats below)
  • Manual test (add detailed scripts or steps below)
  • Other

6. Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

@hoangndst hoangndst requested a review from Yangyang96 as a code owner May 16, 2025 21:26
@hoangndst hoangndst added the documentation Improvements or additions to documentation label May 16, 2025
@hoangndst hoangndst requested a review from ffforest May 17, 2025 05:34
@hoangndst hoangndst merged commit 951f88b into KusionStack:main May 19, 2025
2 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators May 19, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: add contribution flow guidelines

1 participant