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.

Sign up for GitHub

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: List conventional commit tags in DEVELOPMENT.md #191

Merged
merged 4 commits into from
Oct 31, 2023
Merged

docs: List conventional commit tags in DEVELOPMENT.md #191

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a20b8f4
doc: List conventional commit tags in DEVELOPMENT.md
aborgna-q Oct 18, 2023
8c9ee5f
typo
aborgna-q Oct 19, 2023
cff39f9
Merge branch 'main' into doc/conv-commit-doc
aborgna-q Oct 20, 2023
1fc7006
Merge branch 'main' into doc/conv-commit-doc
aborgna-q Oct 24, 2023
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
37 changes: 31 additions & 6 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,14 @@ To setup the environment manually you will need:
pip install -r pyrs/dev-requirements.txt
```

You can use the git hook in [`.github/pre-commit`](.github/pre-commit) to automatically run the test and check formatting before commiting.

You can use the git hook in [`.github/pre-commit`](.github/pre-commit) to automatically run the test and check formatting before committing.
To install it, run:

```bash
cp .github/pre-commit .git/hooks/pre-commit
ln -s .github/pre-commit .git/hooks/pre-commit
# Or, to check before pushing instead
cp .github/pre-commit .git/hooks/pre-push
ln -s .github/pre-commit .git/hooks/pre-push
```

## 🏃 Running the tests
Expand Down Expand Up @@ -98,8 +99,32 @@ black .
We also check for clippy warnings, which are a set of linting rules for rust. To run clippy, run:

```bash
cargo clippy

# Include code not compiled in the main build
cargo clippy --all-targets
```

## 🌐 Contributing to tket2

We welcome contributions to tket2! Please open [an issue](https://github.com/CQCL/tket2/issues/new) or [pull request](https://github.com/CQCL/tket2/compare) if you have any questions or suggestions.

PRs should be made against the `main` branch, and should pass all CI checks before being merged. This includes using the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) format for the PR title.

The general format of a contribution title should be:

```
<type>(<scope>)!: <description>
```

Where the scope is optional, and the `!` is only included if this is a semver breaking change that requires a major version bump.

We accept the following contribution types:

- feat: New features.
- fix: Bug fixes.
- docs: Improvements to the documentation.
- style: Formatting, missing semi colons, etc; no code change.
- refactor: Refactoring code without changing behaviour.
- perf: Code refactoring focused on improving performance.
- test: Adding missing tests, refactoring tests; no production code change.
- ci: CI related changes. These changes are not published in the changelog.
- chore: Updating build tasks, package manager configs, etc. These changes are not published in the changelog.
- revert: Reverting previous commits.