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

📝 Add docs for contributing to the dataservice #683

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

chris-s-friedman
Copy link
Contributor

@chris-s-friedman chris-s-friedman commented Sep 4, 2024

Add documentation for contributing to the dataservice. right now, this discusses adding new fields, making PR's and releasing new versions

@chris-s-friedman chris-s-friedman requested a review from a team as a code owner September 4, 2024 16:13
@chris-s-friedman chris-s-friedman force-pushed the docs/cf/contributing branch 3 times, most recently from b7cde05 to 1304995 Compare September 4, 2024 19:25
@chris-s-friedman chris-s-friedman force-pushed the docs/cf/contributing branch 3 times, most recently from 57ad790 to 47a6547 Compare September 5, 2024 16:59
📝 Add contributing docs

🚨 Fix codacy issues

🚨 Hopefully adding some text after first heading helps

🚨 Removed the md043 linting

Update CONTRIBUTING.md

Co-authored-by: Natasha Singh <[email protected]>

Update CONTRIBUTING.md

Co-authored-by: Natasha Singh <[email protected]>

Update CONTRIBUTING.md

Co-authored-by: Natasha Singh <[email protected]>

Update CONTRIBUTING.md

Co-authored-by: Natasha Singh <[email protected]>

Update CONTRIBUTING.md

Co-authored-by: Natasha Singh <[email protected]>

Update CONTRIBUTING.md

Co-authored-by: Natasha Singh <[email protected]>

🚨 Fi linting issues

📝 Updating docs

Update CONTRIBUTING.md

Co-authored-by: Natasha Singh <[email protected]>

Update CONTRIBUTING.md

Co-authored-by: Natasha Singh <[email protected]>

📝 Move migration before testing

📝 Put diagram in a code block
the new field:

```python
:param new_field_name: Description of the new field.
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
:param new_field_name: Description of the new field.
:param new_field_name: Description of the new field.
:type new_field_name: <type of new_field_name>

Copy link
Member

@znatty22 znatty22 left a comment

Choose a reason for hiding this comment

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

Looks good! Approved for future, but left just one minor comment

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.

2 participants