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 documentation to support developers #343

Merged
merged 34 commits into from
Jan 6, 2025
Merged

Add documentation to support developers #343

merged 34 commits into from
Jan 6, 2025

Conversation

tatiana
Copy link
Collaborator

@tatiana tatiana commented Jan 6, 2025

Add documentation to support developers, including:

  1. Overview of how to contribute
  2. How to set up the local development environment
  3. Running tests
  4. Pre-commit and linting
  5. Authoring the documentation
  6. Releasing

Closes: #232

@tatiana tatiana requested a review from a team as a code owner January 6, 2025 14:14
@codecov-commenter
Copy link

codecov-commenter commented Jan 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.68%. Comparing base (c181a5f) to head (af863fd).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #343   +/-   ##
=======================================
  Coverage   93.68%   93.68%           
=======================================
  Files          10       10           
  Lines         792      792           
=======================================
  Hits          742      742           
  Misses         50       50           

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

@tatiana tatiana requested a review from a team January 6, 2025 14:29
Copy link
Contributor

@pankajkoti pankajkoti left a comment

Choose a reason for hiding this comment

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

This is a great help for contributors, thanks a lot for adding this!

LGTM, few minor cosmetic suggestions inline.

docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/howto.md Outdated Show resolved Hide resolved
Copy link

@lzdanski lzdanski left a comment

Choose a reason for hiding this comment

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

Copyediting review

docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/howto.md Outdated Show resolved Hide resolved
docs/contributing/roles.md Outdated Show resolved Hide resolved
tatiana and others added 16 commits January 6, 2025 16:14
docs/contributing/howto.md Outdated Show resolved Hide resolved
@tatiana
Copy link
Collaborator Author

tatiana commented Jan 6, 2025

Thank you so much for the thorough review and documentation lesson, @lzdanski ! I've taken notes for the following documents I do - so I can avoid the same mistakes. I addressed all the feedback.

@tatiana tatiana merged commit 70771d8 into main Jan 6, 2025
67 checks passed
@tatiana tatiana deleted the contribute-docs branch January 6, 2025 17:49
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.

Add dev docs
4 participants