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

609 docs improve contributingmd #610

Merged
merged 10 commits into from
Dec 13, 2024
Merged

Conversation

cpaniaguam
Copy link
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
Copy link

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
Collaborator

@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
5 checks passed
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