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

docs: add code-of-conduct and contributing documents #722

Merged
merged 9 commits into from
Sep 5, 2023

Conversation

Turupawn
Copy link
Member

@Turupawn Turupawn commented Aug 4, 2023

Purpose or design rationale of this PR

Added the following documents that should be helpful when we open source this repo:

  • Code of conduct: based on Covenant COD, recommended by github
  • Contribute: guide for developers wanting to contribute to this repo based on this template

PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
  • ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
  • docs: Documentation-only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Deployment tag versioning

Has tag in common/version.go been updated?

  • No, this PR doesn't involve a new deployment, git tag, docker image tag
  • Yes

Breaking change label

Does this PR have the breaking-change label?

  • No, this PR is not a breaking change
  • Yes

CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
@Thegaram Thegaram changed the title [docs] Opensource docs: Added explanatory documents for opensourcing docs: add code-of-conduct and contributing documents Sep 4, 2023
Thegaram
Thegaram previously approved these changes Sep 4, 2023
README.md Outdated Show resolved Hide resolved
Co-authored-by: Haichen Shen <[email protected]>
README.md Outdated Show resolved Hide resolved
icemelon
icemelon previously approved these changes Sep 5, 2023
@icemelon icemelon merged commit 33089b8 into develop Sep 5, 2023
2 checks passed
@icemelon icemelon deleted the opensource-docs branch September 5, 2023 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants