Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (44 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

57 lines (44 loc) · 3.42 KB
Raw

Contributing to GoogleTakeoutFixer

First off, thank you for considering contributing to this project! I really appreciate any help!

Ways to contribute

  • Report bugs: Please report bugs in the issue tracker.
  • Suggest features: If you have any ideas for new features or improvements, please share them in the issue tracker.
  • Share the project with people who might find it useful
  • Star the GitHub repository
  • Donate to the project (see Donate section below)

Reporting bugs

Before reporting a bug, please make sure to do the following:

  1. Check the issue tracker to see if the bug has already been reported.
  2. Make sure you are using the latest version of GoogleTakeoutFixer
  3. Make sure you followed the instructions in the README correctly.

A good bug report includes the following information:

  • A clear description of the issue
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots or logs
  • Your operating system and version

Pull requests

Before submitting a pull request

Before submitting a pull request, please check the issue tracker to see if there are any existing issues that your pull request addresses. If not, you can create a new issue to discuss your proposed changes before submitting a pull request. This can help ensure that your changes are wanted and that they align with the project's goals. You don't have to create an issue for small changes (e.g. fixing typos) but for larger changes (e.g. adding a new feature), please create an issue first. Not creating an issue for larger changes can lead to your pull request being closed without merging.

Process

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes following the existing code style and conventions
  4. Test your changes
  5. Commit your changes with a clear commit message following the Conventional Commits format
  6. Create a pull request with a clear description of what you have done and why

Also please link relevant issues in your pull request description (e.g. "Closes #123").

AI usage

AI tools (Claude etc.) may be used to assist with contributing, but:

  • You may use AI for suggestions and autocompletion
  • You must review/edit and understand everything you submit
  • You must be transparent about your AI usage
  • You must not use agentic AI to automatically generate complete pull requests or issues

If you want to contribute your ideas but don't have the time/skills to do so, please consider supporting the project in other ways, for example by opening issues with your enhanced ideas instead of prompting AI to do everything for you.

License

By contributing to this project, you agree that your contributions will be licensed under the GNU General Public License v3.0.

Donate

Donating is not mandatory but greatly appreciated 🙏! You can support me via my monero (cryptocurrency) address:

XMR: 86ApiK5RFKeVsaEDreQvvkE5Mdo6p3xwtGAZTcbf7JKFDnJ4bG52zqsZjAzgFW6prWhfarinBLrCpW8faxKotG26RcRD4fQ

If you don't want to donate to this project or don't have anything to do with monero/cryptocurrencies, please consider donating to/supporting other open source projects that you use and love!