Skip to content

Latest commit

 

History

History
103 lines (66 loc) · 4.37 KB

CONTRIBUTING.md

File metadata and controls

103 lines (66 loc) · 4.37 KB

Contributing

First of all, thank you for being interested in contributing to HealthChain, we welcome contributions of all kinds! Listed below are some of the ways you can get involved.

Reporting Issues

Found a bug? Have a suggestion for a new feature? You can help us improve by:

  • Submitting Bug Reports: Clearly describe the issue, including steps to reproduce it, the expected outcome, and any relevant screenshots or logs.
  • Suggesting Enhancements: Share your ideas for new features or improvements. Please provide as much detail as possible to help us understand your vision.

Improving Documentation

Good documentation helps others understand and use our project. You can contribute by:

  • Updating Existing Documentation: Fix typos, clarify instructions, and ensure all information is up to date.
  • Creating New Documentation: Write new guides, tutorials, or examples that help users and developers get the most out of our project.

Writing Code

If you're a developer, there are many ways you can contribute code:

  • Fixing Bugs: Look through the issue tracker and find bugs that you can fix. Be sure to reference the issue number in your commit messages.
  • Implementing Features: Work on new features or enhancements. Discuss your ideas with the maintainers first to make sure they align with the project's goals.
  • Improving Tests: Increase test coverage and ensure the codebase is robust and reliable.

Join Our Discord

Are you a domain expert with valuable insights? We encourage you to join our Discord community and share your wisdom. Your expertise can help shape the future of the project and guide us in making informed decisions.

We believe that every contribution, big or small, makes a difference. Thank you for being a part of our community!

How to Contribute Code

This project uses poetry for dependency management. For more information see the poetry documentation.

  1. Fork the repository to your own GitHub account. For more details check out github documentation.

  2. Clone the forked repository to your local machine.

  3. Run poetry install --with dev to install all the necessary development dependencies.

  4. Try running poetry run pytest to check that all is working as expected.

  5. Create a new branch for your feature or bugfix.

    git checkout -b my-feature-branch

  6. Pre-commit is a package for checking and auto-formatting code to have a consistent style. If you don't have pre-commit installed locally then you may need to follow the instructions here. You can then install our hooks by running:

    pre-commit install

  7. Make your changes and commit them with descriptive commit messages.

    git commit -m "Add new feature to do X"

  8. Push your changes to your forked repository.

    git push origin my-feature-branch

  9. Open a pull request on the original repository.

Contributing to Documentation

We use Mkdocs for our documentation site. To download the dependencies for documentation, run:

poetry install --with docs

To preview the docs page in development:

poetry run mkdocs serve

Writing Clear Documentation

  • Be Concise: Use clear and concise language to explain concepts and instructions.
  • Use Headings: Organize content with headings and subheadings to improve readability.
  • Code Examples: Include code examples to illustrate usage and functionality.
  • Consistent Style: Follow a consistent style and format throughout the documentation.
  • Active Voice: Write in the active voice to make instructions direct and easy to follow.
  • Bullet Points: Use bullet points or numbered lists for steps and key points.

Testing

Make sure to add tests for any new functionality you add. Run all tests to ensure that your changes do not break existing functionality.

Pull Request Process

  1. Ensure your changes comply with the style guide.
  2. Ensure all tests pass.
  3. Open a pull request with a clear title and description of your changes.
  4. A project maintainer will review your pull request and may request changes.
  5. Once approved, your pull request will be merged.

Thank you for your contributions!