We welcome contributions to SussyFinder! This document outlines how you can get involved and contribute your valuable skills and expertise.
- Fork the repository: Create your own fork of the Sussyfinder repository on GitHub. This will allow you to make changes and submit pull requests without affecting the main branch.
- Clone your fork: Clone your forked repository to your local machine.
- Create a branch: Create a new branch for your specific changes. This helps keep your work organized and separate from the main branch.
- Make your changes: Make your desired changes to the codebase.
- Commit your changes: Commit your changes with meaningful commit messages that describe what you have changed.
- Push your changes: Push your changes to your branch on your fork.
- Create a pull request: Create a pull request from your branch to the main branch of the upstream repository. This will notify the project maintainers about your proposed changes.
- Follow the existing code style conventions of the project. This ensures consistency and readability.
- Use consistent formatting and indentation.
- Add meaningful comments to explain complex code sections.
- Make sure your changes pass all existing tests.
- If necessary, write new tests to cover your changes.
- Clearly describe your changes in the pull request title and description.
- Mention the issue number if your pull request addresses a specific issue.
- Be patient and responsive to feedback from the project maintainers.
- We encourage you to open issues for bugs, feature requests, or any questions you may have.
- Feel free to ask for help or clarification from the project maintainers.
- We appreciate your contributions and look forward to working with you!
Sussyfinder is licensed under the GPLv3 license. See the LICENSE file for more details.