Skip to content
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
51 changes: 48 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [Autogenerated Documentation](#autodocs)
- [Custom Documentation](#customdocs)
- [Development Status](#status)
- [Pubic Release Notes](#releasenotes)


## Installation and Development<a name="install"></a>
Expand Down Expand Up @@ -210,9 +211,53 @@ One of the outstanding features of sphinx is its support for arbitrarily organiz
materials such as tutorials, introductions, and other context-providing content. These items should
be stored in source control under the `docs/source` directory in properly formatted `.rst` files.



## Development Status<a name="status"></a>

Classes and methods may be marked as *alpha* by including `[ALPHA]` at the start of their docstrings.
These methods are intended for development, testing, and experimentation, are not supported, and may change or be removed without notice
These methods are intended for development, testing, and experimentation, are not supported, and may change or be removed without notice.

## Public Release Notes<a name="releasenotes"></a>

When releasing a version of Citrine Python for use by customers through exchanges like PyPI,
include release notes in the folloing template format.

### vx.x.x is released!
Here is a short overview of the main changes in this release.
This is written in a friendly tone, avoids jargon, and conveys enthusiasm!
This section should be ~2-3 sentences and highlight the “what” and the “why” of this release.
Citrine has a personality, and its personality should come through in both this paragraph and the writing through the release notes.

### What’s New
* DO: Use these bullets to specify new and never before seen features
* DO: Add a short description of each new feature and its name if it has one
* DO: Share particularly exciting screenshots or GIFs of new features easily encapsulated in an image format
* DO: Keep each bullet to 1-3 sentences (3 sentences max, 1-2 ideal), but DO use sub-lists if a new feature requires extra explanation
* DO: Include links in each bullet to any important public-facing landing pages, docs, blog posts, resources, etc. relevant to the feature being discussed
* DON’T: Use these bullets to talk about improvements, that’s the next section!
* DON’T: Use these bullets to talk about bug fixes, that’s later!
* DON’T: Use these bullets to discuss things still in progress
* EXAMPLE: Likes have been in development for 6 months and now that they’re here, you can finally let your friends know how much you appreciate their content. Below each post is now a Like button you can click to express your enthusiasm.

### Improvements
* DO: Use these bullets to specify aspects of the product that have a better UI/UX
* DO: Use these bullets to specify aspects of the product that are faster or more performant
* DO: Use these bullets to address improvements requested by users
* DO: Share particularly exciting screenshots or GIFs of improvements easily encapsulated in an image format
* DO: Keep each bullet to 1-3 sentences (3 sentences max, 1-2 ideal)
* DON’T: Use these bullets to talk about bug fixes, that’s the next section!
* DON’T: Use these bullets to discuss things still in progress
* EXAMPLE: Uploading content to the platform has never been faster. With this release, something that took 30 seconds before now should now use much less time.

### Fixes
* DO: Use these bullets to describe specific bug fixes
* DO: Explain the before and after of the bug fix
* DO: Keep each bullet to 1-3 sentences (3 sentences max, 1-2 ideal)
* DON’T: Use these bullets to talk about general improvements that were not actually bugs
* EXAMPLE: A bug causing a confusing error message when entering an incorrect password has been fixed.
Now, if you type your password incorrectly you’ll get a helpful message and a link to reset your password.

### Deprecated
* DO: Use these bullets to list features that are now deprecated
* DO: Explain how the deprecated feature will be replaced, if it will, or other key workarounds.
* DO: Give a very brief explanation for the deprecation.
* EXAMPLE: As of this release, the /filter endpoint is now deprecated in favor of the new, faster, and more robust /search endpoint.
4 changes: 2 additions & 2 deletions docs/source/getting_started/datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ Dataset Access, Sharing, and Transfer

Immediately after a Dataset is created on the Citrine Platform, only members of the Team in which it was created can see it and interact with it.

Sharing With a Specific Project
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sharing With a Specific Team
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A Dataset can be shared with another team using the :func:`~citrine.resources.team.Team.share` method on the original project.

Expand Down
2 changes: 1 addition & 1 deletion src/citrine/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "3.11.0"
__version__ = "3.11.1"