Contributing to NeatShift

Hey there! Thanks for considering contributing to NeatShift. Whether you're fixing bugs, adding features, or improving documentation, your help makes NeatShift better for everyone.

Branch Strategy

We use a two-branch system:

main - stable branch for releases
develop - branch for active development and contributions

Always create your changes in develop, not main!

Quick Start

Fork the repo
Clone your fork: git clone https://github.com/your-username/NeatShift.git
Create your feature branch from develop: git checkout develop && git checkout -b cool-new-feature
Make your changes
Test your changes
Commit: git commit -m 'Add some feature'
Push: git push origin cool-new-feature
Open a Pull Request targeting the develop branch

Development Setup

Make sure you have .NET 6.0 SDK installed
Open the solution in Visual Studio 2022 or your preferred IDE
Restore NuGet packages
Build and run!

What Can I Work On?

Check out our open issues
Look for issues tagged with good-first-issue if you're just starting
Feel free to propose new features through issues

Code Style

We keep it simple:

Use standard C# naming conventions
Keep methods focused and small
Add comments for non-obvious code
Include XML documentation for public APIs

Making Changes

Always Branch from Develop: Your changes should be based on the develop branch
Keep Changes Small: Smaller PRs are easier to review
Write Good Commit Messages: Explain what and why, not how
Update Documentation: If you change functionality, update the docs
Add Tests: New features should include tests
Test Your Changes: Make sure everything still works!

Pull Request Process

Make sure your PR targets the develop branch
Update the README.md if needed
Make sure your code builds clean without warnings
Write a good PR description explaining:
- What you changed
- Why you changed it
- How to test it
Link any related issues

Need Help?

Check out our documentation
Create an issue with your question
Join our discussions

Bug Reports

Found a bug? Please include:

Steps to reproduce
What you expected to happen
What actually happened
Screenshots if relevant
Your environment (OS, .NET version, etc.)

Feature Requests

Have an idea? Great! Create an issue and:

Explain the feature
Why it would be useful
How it should work
Any implementation ideas you have

Code Review Process

At least one maintainer will review your PR
We might suggest changes
Once approved, it will be merged into develop
Changes in develop will be periodically merged to main for releases

Thanks for contributing to NeatShift! 🚀

2.8 KiB Raw Permalink Blame History