diff options
author | Nathan Fargo <32229490+ntfargo@users.noreply.github.com> | 2024-06-18 19:22:35 +0200 |
---|---|---|
committer | Nathan Fargo <32229490+ntfargo@users.noreply.github.com> | 2024-06-18 19:22:35 +0200 |
commit | 23b5139b7a6e9f6c74b7611d3b81d5ea774dd8f5 (patch) | |
tree | 86a663fb7077734ff680e01aaccfcce36fe4caae | |
parent | 046f10d7a389a0c6d27ac80a993497894999dbcd (diff) |
Contributing.main
-rw-r--r-- | CONTRIBUTING.md | 62 | ||||
-rw-r--r-- | SequenceViewer/uploads/.gitkeep | 0 |
2 files changed, 62 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0eea9c9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,62 @@ +# Contributing to Linear Fox | GenoFusion +We are excited that you are interested in contributing to GenoFusion! By contributing, you help improve the tools and resources available to the bioinformatics community. Below are the guidelines for contributing to the project. + +## Table of Contents +1. [Getting Started](#getting-started) +2. [How to Contribute](#how-to-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Enhancements](#suggesting-enhancements) + - [Submitting Pull Requests](#submitting-pull-requests) +3. [Code of Conduct](#code-of-conduct) +4. [Community](#community) +5. [License](#license) + +## Getting Started +Follow installation from the [README.md](../README.md) file to set up your environment and get started with GenoFusion. + +## How to Contribute +### Reporting Bugs +- If you encounter a bug, please open an issue on GitHub. Include as much detail as possible, such as: +- Steps to reproduce the bug +- Expected and actual behavior +- Screenshots, if applicable +- Environment details (operating system, Python version, etc.) + +## Suggesting Enhancements +We welcome suggestions for improvements. If you have an idea for a new feature or enhancement, please open an issue on GitHub. Provide a clear and concise description of the proposed enhancement, including any relevant context or benefits. + +### Submitting Pull Requests +1. Ensure your changes align with the project’s goals and guidelines. +2. Create a new branch for your changes: +```bash +git checkout -b feature/your-feature-name +``` +3. Make your changes, ensuring that your code is well-documented and tested. +4. Commit your changes with a descriptive commit message: +5. Push your branch to your forked repository +6. Open a pull request on GitHub with a clear description of your changes. + +## Code of Conduct +We expect all contributors to adhere to the [Code of Conduct](../CODE_OF_CONDUCT.md) when participating in the GenoFusion project. + +# Style Guides +## Python Style Guide +- Follow PEP 8 for Python code. +- Ensure your code is well-documented with docstrings. +- Use type annotations where appropriate. + +## Git Commit Messages +- Use the present tense ("Add feature" not "Added feature"). +- Capitalize the first letter of the message. +- Limit the subject line to 50 characters. +- Include a body if the message needs more explanation, wrapping at 72 characters. + +## Community +Join our community to discuss ideas, ask questions, and share feedback: +- [GitHub Discussions](https://github.com/linearfox/genofusion/discussions) +- Email: support@linearfox.com + +## License +By contributing to GenoFusion, you agree that your contributions will be licensed under the Apache License 2.0. + +Thank you for your interest in contributing to GenoFusion! Your contributions are valuable and appreciated. diff --git a/SequenceViewer/uploads/.gitkeep b/SequenceViewer/uploads/.gitkeep deleted file mode 100644 index e69de29..0000000 --- a/SequenceViewer/uploads/.gitkeep +++ /dev/null |