Thank you for your interest in contributing to GHRelease! We value contributions from the community, whether you're fixing bugs, improving documentation, or adding features. Here's a quick guide to help you get started.
- Code of Conduct
- How to Contribute
- Setting Up the Development Environment
- Pull Request Guidelines
- License
Please follow our Code of Conduct to ensure a welcoming and respectful environment for everyone.
If you've found a bug in DunTasks, please:
- Check for existing issues to see if it has already been reported.
- Open a new issue with a clear and concise description, including steps to reproduce, expected behavior, and screenshots, if applicable.
We’re always open to new ideas! To suggest an enhancement:
- Open a new issue and provide a clear description of the improvement.
- Include your reasoning behind the suggestion, and discuss any potential challenges.
We welcome contributions to the codebase. Here’s how you can help:
- Fork the repository and clone it locally.
- Create a new branch for your work:
git checkout -b feature/my-new-feature - Make your changes and test them thoroughly.
- Commit your changes:
git commit -m "Add feature/fix bug: [description]" - Push to your branch:
git push origin feature/my-new-feature - Open a Pull Request (PR) and provide a detailed description of the changes.
-
Fork the repository and clone it locally:
git clone https://github.com/thisuxhq/ghrelease.git cd ghrelease -
Install the necessary dependencies:
bun install
-
Run the project locally:
bun run dev
- Ensure all commits are descriptive and meaningful.
- Before submitting a PR, run the test suite to ensure your changes don't break anything.
- Provide a detailed description of the changes in the PR.
- If your PR fixes an issue, link to it using the
Fixes #issue_numbersyntax.
By contributing, you agree that your contributions will be licensed under the MIT License.