Contribute To FediFetcher

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. The purpose of this guide is to help you, if you want to contribute but aren't quite sure how. FediFetcher is a really small project, and as such we can be quite flexible with how we accept contributions. Please see this guide as supportive, rather than restrictive.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which I would also be very happy about:

• Star the project
• Post about it on Mastodon
• Spread the word in other ways

Table of Contents

• I Have a Question
• I Want To Contribute
  • Reporting Bugs
  • Suggesting Enhancements
  • Contributing to the code
  • Improving The Documentation
• Attribution

I Have a Question

If you want to ask a question, I assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.

If you have any other question or need clarification, I recommend the following:

• Open an Issue.
• Provide as much context as you can about what you're running into.

I will then take care of the issue as soon as possible.

If you prefer, you can also ask me questions directly on Mastodon @michael@thms.uk, but please don't send me PNs - I prefer resolving issues in public, so that resolutions will be available for others to refer to in the future.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

I use GitHub issues to track bugs and errors. If you run into an issue with the project:

• Open an Issue.
• Explain the behaviour you would expect and the actual behaviour.
• Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own.
• Include any relevant logs, and if you are running FediFetcher as GitHub Action, please link to the GitHub Action execution.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for FediFetcher, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Enhancement suggestions are tracked as GitHub issues. I suggest you do the following when making a suggestion:

• Use a clear and descriptive title for the issue to identify the suggestion.
• Provide a step-by-step description of the suggested enhancement in as many details as possible.
• Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
• Explain why this enhancement would be useful to most FediFetcher users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Contributing to the code

If you wish to contribute to the code of FediFetcher, you are very welcome to. Ideally, have a look at the GitHub issues to see if there are any outstanding issues that you wish to help implement or fix. If you do decide to take on an open issue, please leave a quick comment, so that I know you are working on this, and don't duplicate effort unnecessarily.

You are also free to contribute things that are not on the Issue Tracker.

Either way, to contribute, please note that I use GitHub Pull Requests to manage contributions. When you believe your code is ready, simply send a Pull Request.

Please provide a good description of any changes you have made, and importantly the reasoning behind them. If your contribution refers to an existing issue, please reference this issue in your Pull Request description.

I will then endeavour to review your request promptly, with the aim of merging as soon as I can, but please be patient: FediFetcher is a 'one-man-project', and I do take holidays from time time.

Improving The Documentation

I welcome improvements of the documentation. The content of the documentation can be found in this GitHub repository https://github.com/nanos/FediFetcher-docs, and you are welcome to send Pull Requests there.

As with contributions to the code itself, please provide a good description of any changes you have made, and importantly the reasoning behind them. If your contribution refers to an existing issue, please reference this issue in your Pull Request description.

I will then endeavour to review your request promptly, with the aim of merging as soon as I can, but please be patient: FediFetcher is a 'one-man-project', and I do take holidays from time time.

To discuss the documentation, please use the main FediFetcher GitHub Issue Tracker.

Attribution

This guide is based on the contributing-gen. Make your own!