BetterSEQTA-Plus/CONTRIBUTING.md

Contributing to BetterSEQTA+

Hey there! 👋 Thanks for your interest in contributing to BetterSEQTA+! We're excited to have you join our community of contributors.

🚀 New Contributors Start Here!

Never contributed to an open source project before? No worries! We've made it super easy to get started:

• 📖 Read our contributing guide - This walks you through everything step-by-step, from setting up your development environment to making your first pull request.
• 🏗️ Understand the codebase with the architecture guide
• 🔧 Having issues? Check the troubleshooting guide

We have lots of good first issue labels that are perfect for beginners!

Discussion Before Contributing

For significant changes, please first discuss what you'd like to change via:

• Opening an issue
• Joining our Discord server
• Emailing the maintainers

This helps ensure your contribution aligns with the project's goals and saves you time!

Community

Join our community channels to discuss the project, get help, and connect with other contributors:

• Discord Server: Join our Discord
• GitHub Discussions: For longer-form conversations
• GitHub Issues: For bug reports and feature requests

Creating Plugins

If you're interested in creating plugins for BetterSEQTA+, check out our plugin development guides:

• Plugin development
• Plugin API

Pull Request Process

1. It is recommended to start by opening an issue to discuss the change you wish to make. This will allow us to discuss the change and ensure it is a good fit for the project.
2. Fork the repo and create your branch from main.
3. When writing your pull request, make sure to use the pull request template.

Pull Request Template

## Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

Issues

Create a new issue

If you spot a problem with the readme or code, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.