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: link fix and PR naming section #161

Merged
merged 1 commit into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,18 @@ Follow these code formatting guidelines:
- Include unit tests when you contribute bug fixes and new features. Unit tests help prove that your code works correctly and protects against future breaking changes.
- Make sure that the code coverage checks and automatic tests for pull requests pass.

### Pull Request naming
Use one of the following prefixes for the title of your PR:
- `fix: `
- `feat: `
- `docs: `
- `chore: `
- `ci: `
- `perf: `
- `refactor: `
- `style: `
- `test: `

### Additional questions

If you have any questions that aren't answered in these guidelines, please find us in the #contributor channel of the [Label Studio Slack Community](https://slack.labelstud.io/?source=github-sdk-contrib).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This is the first release of the Label Studio SDK. It supports Label Studio Ente

- **Find a bug?** [Create a GitHub issue](https://github.com/heartexlabs/label-studio-sdk/issues)!
- **Have a question?** [Join the Slack Community](https://slack.labelstud.io/?source=github-sdk)!
- **Want to contribute?** [See the contributing guide](https://github.com/heartexlabs/label-studio-sdk/CONTRIBUTING.md)
- **Want to contribute?** [See the contributing guide](CONTRIBUTING.md)

## Quickstart
To start using the SDK in your machine learning and data science projects and pipelines, do the following:
Expand Down