diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1caa3473..e5cf5dd46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,7 @@ - [Autogenerated Documentation](#autodocs) - [Custom Documentation](#customdocs) - [Development Status](#status) +- [Pubic Release Notes](#releasenotes) ## Installation and Development @@ -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 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 + +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. diff --git a/docs/source/getting_started/datasets.rst b/docs/source/getting_started/datasets.rst index 429b15be0..cbbb19d8b 100644 --- a/docs/source/getting_started/datasets.rst +++ b/docs/source/getting_started/datasets.rst @@ -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. diff --git a/src/citrine/__version__.py b/src/citrine/__version__.py index fcbd6954b..595a2b3bb 100644 --- a/src/citrine/__version__.py +++ b/src/citrine/__version__.py @@ -1 +1 @@ -__version__ = "3.11.0" +__version__ = "3.11.1"