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

Jump to bottom

Update Docs #972

Merged
merged 3 commits into from
Nov 8, 2024
Merged

Update Docs #972

merged 3 commits into from
Nov 8, 2024

Conversation

jspeerless
Copy link
Collaborator

Update header for dataset sharing

Citrine Python PR

Description

Minor updates to documentation to

  • Correct mention of projects in sharing
  • Add instructions for release notes (deleted from Confluence)

PR Type:

  • Breaking change (fix or feature that would cause existing functionality to change)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Maintenance (non-breaking change to assist developers)

Adherence to team decisions

  • I have added tests for 100% coverage
  • I have written Numpy-style docstrings for every method and class.
  • I have communicated the downstream consequences of the PR to others.
  • I have bumped the version in __version__.py

@jspeerless
Update datasets.rst
537d35d 
Update header for dataset sharing
@jspeerless
Update CONTRIBUTING.md
eff2e55 
Include Release Notes Template
@jspeerless
Update __version__.py
573ab25
@jspeerless jspeerless changed the title Update datasets.rst Update Docs Nov 8, 2024
@jspeerless jspeerless marked this pull request as ready for review November 8, 2024 14:56
@jspeerless jspeerless requested a review from a team as a code owner November 8, 2024 14:56
ventura-rivera
ventura-rivera approved these changes Nov 8, 2024
View reviewed changes
Copy link
Contributor

@ventura-rivera ventura-rivera left a comment

Choose a reason for hiding this comment

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

lgtm!

@jspeerless jspeerless merged commit baf7fdc into main Nov 8, 2024
16 checks passed
@jspeerless jspeerless deleted the doc_update branch November 8, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ventura-rivera ventura-rivera ventura-rivera approved these changes

@anoto-moniz anoto-moniz anoto-moniz approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jspeerless @ventura-rivera @anoto-moniz