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 DEVELOPMENT.md #584

Merged
merged 3 commits into from
Oct 21, 2024
Merged

docs: Add DEVELOPMENT.md #584

merged 3 commits into from
Oct 21, 2024

Conversation

aborgna-q
Copy link
Collaborator

Mostly copied from HUGR's.

drive-by: Remove "experimental execution" (guppy-runner) section from the readme.

@aborgna-q aborgna-q requested a review from a team as a code owner October 21, 2024 14:38
@aborgna-q aborgna-q requested a review from ss2165 October 21, 2024 14:38
@codecov-commenter
Copy link

codecov-commenter commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.64%. Comparing base (2a7522f) to head (4735c58).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #584   +/-   ##
=======================================
  Coverage   91.64%   91.64%           
=======================================
  Files          59       59           
  Lines        6269     6269           
=======================================
  Hits         5745     5745           
  Misses        524      524           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

DEVELOPMENT.md Outdated
To setup the environment manually you will need:

- Just: https://just.systems/
- uv `>=0.3`: docs.astral.sh/uv/getting-started/installation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- uv `>=0.3`: docs.astral.sh/uv/getting-started/installation
- uv `>=0.3`: https://docs.astral.sh/uv/getting-started/installation/

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Formated the links as [domain](long-url) for clarity.

DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated

The wheel building process and publication to PyPI is handled by the CI.
Just create a [github release](https://github.com/CQCL/guppylang/releases/new) from the **unmerged** branch.
The release tag should follow the format used in the previous releases, e.g. `hugr-py-v0.1.1`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mention the need to also merge the changelog/version changes back in to main

@aborgna-q aborgna-q requested a review from ss2165 October 21, 2024 15:25
@aborgna-q aborgna-q added this pull request to the merge queue Oct 21, 2024
Merged via the queue into main with commit 1d29d39 Oct 21, 2024
3 checks passed
@aborgna-q aborgna-q deleted the ab/development branch October 21, 2024 15:32
github-merge-queue bot pushed a commit that referenced this pull request Nov 12, 2024
🤖 I have created a release *beep* *boop*
---


## [0.13.0](v0.12.2...v0.13.0)
(2024-11-12)


### ⚠ BREAKING CHANGES

* `prelude` module renamed to `std`

### Features

* add `qubit` discard/measure methods
([#580](#580))
([242fa44](242fa44))
* Add `SizedIter` wrapper type
([#611](#611))
([2e9da6b](2e9da6b))
* conventional results post processing
([#593](#593))
([db96224](db96224))
* Improve compiler diagnostics
([#547](#547))
([90d465d](90d465d)),
closes [#551](#551)
[#553](#553)
[#586](#586)
[#588](#588)
[#587](#587)
[#590](#590)
[#600](#600)
[#601](#601)
[#606](#606)
* restrict result tag sizes to 256 bytes
([#596](#596))
([4e8e00f](4e8e00f)),
closes [#595](#595)


### Bug Fixes

* Mock guppy decorator during sphinx builds
([#622](#622))
([1cccc04](1cccc04))


### Documentation

* Add DEVELOPMENT.md
([#584](#584))
([1d29d39](1d29d39))
* Fix docs build ([#639](#639))
([bd6011c](bd6011c))


### Miscellaneous Chores

* Manually set last release commit
([#643](#643))
([b2d569b](b2d569b))


### Code Refactoring

* rename prelude to std
([#642](#642))
([1a68e8e](1a68e8e))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: Agustín Borgna <agustin.borgna@quantinuum.com>
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.

4 participants