Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 2.67 KB
Raw

Contributing to Pulseq-CEST

We welcome contributions to the Pulseq-CEST project! Your involvement will help improve the project, enhance its compatibility, and ensure reproducibility in CEST research. In this document, we outline the guidelines and best practices for contributing to Pulseq-CEST.

How to Contribute

There are several ways to contribute to the Pulseq-CEST project:

  • Report bugs: If you encounter any bugs or issues, please create an issue on our GitHub repository. Be sure to include detailed information about the bug, steps to reproduce it, and any relevant error messages or logs.
  • Request new features: If you have ideas for new features or improvements, please create an issue on our GitHub repository. Clearly describe the feature you would like to see and provide examples or use cases to help us understand its value.
  • Submit pull requests: If you have made changes to the codebase, fixed bugs, or implemented new features, please submit a pull request. Before submitting a pull request, ensure that your changes adhere to our coding guidelines and standards.
  • Improve documentation: Help us maintain and improve our documentation by fixing typos, adding new tutorials, or enhancing existing content.
  • Participate in discussions: Engage with the community by participating in discussions, sharing your experiences, and providing feedback on the project.

Coding Guidelines and Standards

To ensure consistency and maintainability of the Pulseq-CEST codebase, please adhere to the following coding guidelines and standards:

  • Write clean and well-structured code, with clear comments and explanations where necessary.
  • Use meaningful variable and function names that accurately describe their purpose.
  • Organize your code into functions or classes to improve readability and maintainability.
  • Follow the existing code style and formatting conventions used in the project.

Submitting a Pull Request

Before submitting a pull request, please make sure that your changes are consistent with our coding guidelines and standards. Follow these steps to submit a pull request:

  • Fork the Pulseq-CEST repository on GitHub.
  • Create a new branch for your changes, based on the main branch.
  • Commit your changes to the new branch, with clear and descriptive commit messages.
  • Push your changes to your forked repository.
  • Create a pull request from your forked repository to the Pulseq-CEST main branch.
  • In the pull request description, provide a detailed explanation of your changes, including the motivation behind them and any relevant context.

We appreciate your contributions to the Pulseq-CEST project and look forward to working with you to enhance and improve our open-source tool!