Skip to content

609 docs improve contributingmd#610

Merged
cpaniaguam merged 10 commits intomainfrom
609-docs-improve-contributingmd
Dec 13, 2024
Merged

609 docs improve contributingmd#610
cpaniaguam merged 10 commits intomainfrom
609-docs-improve-contributingmd

Conversation

@cpaniaguam
Copy link
Copy Markdown
Collaborator

This pull request includes updates to the docs/CONTRIBUTING.md file to improve clarity and organization. The changes introduce a Table of Contents, reorganize the contribution guidelines, and provide more detailed instructions for contributing to the HSSM project.

Documentation improvements:

  • Added a Table of Contents to the docs/CONTRIBUTING.md file for easier navigation.
  • Reorganized the sections on ways to contribute, opening issues, and the pull request process to improve readability and flow.
  • Enhanced the step-by-step instructions for creating a pull request, including adding links to relevant GitHub documentation and emphasizing the importance of using feature branches.
  • Provided detailed guidance on using Poetry for dependency management, including how to add new dependencies and commit changes.

@cpaniaguam cpaniaguam linked an issue Dec 12, 2024 that may be closed by this pull request
@codecov
Copy link
Copy Markdown

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

@cpaniaguam cpaniaguam self-assigned this Dec 12, 2024
@cpaniaguam cpaniaguam added the documentation Improvements or additions to documentation label Dec 12, 2024
Copy link
Copy Markdown
Member

@AlexanderFengler AlexanderFengler left a comment

Choose a reason for hiding this comment

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

lgtm

@cpaniaguam cpaniaguam merged commit 12100bd into main Dec 13, 2024
@digicosmos86 digicosmos86 deleted the 609-docs-improve-contributingmd branch February 10, 2026 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: improve CONTRIBUTING.md

2 participants