Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 3.48 KB

Contributing to Slicer-Liver

Thanks for taking the time to contribute! All types of contributions are encouraged and valued. It can be reporting a bug, proposing new features, submitting a fix, etc.

How to help?

Submitting code

We encourage you to submit pull requests as the preferred method for proposing changes to the codebase.

  • Fork the source code
  • Build Slicer-Liver from the source code following instructions
  • Create a new branch for your feature or bug fix to keep your changes organized.
  • Implement your changes, ensuring they adhere to the Python and C++ coding standards used in the project.
  • Commit and push your changes with clear and descriptive messages.
  • Open a pull request in the original repository, clearly describing the changes you made and their purpose.

We look forward to reviewing your contributions!

Report bugs

If you encounter a bug, we encourage you to report it so we can address the issue. To report a bug:

  • Check the issue tracker to see if the bug has already been reported. If the bug has not been reported, create a new issue in the tracker.
  • Include a clear and descriptive title for the issue. Provide detailed steps to reproduce the bug, including the expected and actual outcomes.
  • Specify the environment in which the bug occurred (e.g., operating system, version of Slicer-Liver, and any relevant dependencies).
  • Attach any logs, screenshots, or additional information that can help in diagnosing the issue.

We appreciate your help in making Slicer-Liver better for everyone!

Proposing new feature

We welcome suggestions for new features to improve Slicer-Liver. To propose a new feature:

  • Check existing suggestions: Review the issue tracker to see if the feature has already been proposed.
  • Create a new issue: If the feature has not been suggested, open a new issue in the tracker.
  • Provide a clear title: Use a concise and descriptive title for the feature request.
  • Describe the feature: Clearly explain the feature you are proposing, including its purpose and the problem it aims to solve. Provide context: Include examples, mockups, or use cases that illustrate how the feature will be used.
  • Discuss potential implementation: If you have ideas about how the feature could be implemented, include them in your description.

We value your input and look forward to collaborating on new ideas!

If you have a question?

If you have a question about using or contributing to Slicer-Liver, we’re here to help!

  • Check the documentation: Review the project README for guidance.
  • Search existing discussions: Browse the issue tracker or discussions to see if your question has already been answered.
  • Start a discussion: If you can’t find an answer, create a new discussion. Clearly describe your question or concern.
  • Be specific: Provide as much detail as possible about your question, including the context and any relevant information (e.g., version, environment, or steps you’ve taken).

We aim to build an inclusive and collaborative community, so don’t hesitate to reach out!