Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

74 lines (52 loc) · 2.71 KB

Contribute to the Software

There are many ways to contribute to ggoncoplot.

  1. Request features you would like to by creating new issues on github
  2. [Make your visualisation packages ggoncoplot-compatible]
  3. [Directly contribute to the ggoncoplot codebase]

Make your visualisation packages ggoncoplot-compatible

If your package produces ggplots that you would like to interactively link with ggoncoplot, consider converting your geoms to their ggiraph interactive equivalents and adding a data_id based on a sample identifier column in the dataset. That way end-users can create a data-linked oncoplot composed with your packages plots using patchwork (example)

Directly contribute to the ggoncoplot codebase

We welcome contributions from the community to enhance and expand the functionality of ggoncoplot. Whether you want to fix a bug, add new features, improve documentation, or optimize performance, your efforts are highly valued. To get started:

  1. Fork the Repository: Click on the 'Fork' button at the top right of this page to create a copy of the repository in your GitHub account.

  2. Clone the Repository: Use git clone to clone your forked repository to your local machine.

    git clone https://github.com/selkamand/ggoncoplot.git

  3. Create a Branch

    git checkout -b feature-name

  4. Make Changes: Implement your changes in the new branch

  5. Commit and Push: Commit your changes and push the branch to your forked repository.

  6. Create a Pull Request: Go to the original repository and open a pull request from your branch. Please provide a clear description of your changes and any relevant issues or discussions.

Report Issues or Problems with the Software

If you encounter any issues, bugs, or have suggestions for improvements, please report them using the GitHub Issues Tab.

Seek Support

For any questions or support regarding the use of ggoncoplot you can:

  • Check the Documentation: Comprehensive documentation is available here.

  • Create a new issue with your query.

  • Browse Existing Issues: Check the Issues page to see if your query has been addressed.

  • Contact Us: If you need direct assistance, please contact the maintainers directly