mirror of
https://github.com/bellingcat/auto-archiver.git
synced 2026-06-07 19:08:30 +03:00
49 lines
2.2 KiB
Markdown
49 lines
2.2 KiB
Markdown
# Contributing to Auto Archiver
|
||
|
||
Thank you for your interest in contributing to Auto Archiver! Your contributions help improve the project and make it more useful for everyone. Please follow the guidelines below to ensure a smooth collaboration.
|
||
|
||
### 1. Reporting a Bug
|
||
|
||
If you encounter a bug, please create an issue on GitHub with the following details:
|
||
|
||
* Describe the bug: Provide a clear and concise description of the issue.
|
||
* Steps to reproduce: Include the steps needed to reproduce the bug.
|
||
* Expected behavior: Describe what you expected to happen.
|
||
* Actual behavior: Explain what actually happened.
|
||
* Screenshots/logs: If applicable, attach screenshots or logs to help diagnose the problem.
|
||
* Environment: Mention the OS, Ruby version, and any other relevant details.
|
||
|
||
### 2. Writing a Patch/Fix and Submitting Pull Requests
|
||
|
||
If you’d like to fix a bug or improve existing code:
|
||
|
||
1. Open a pull request on GitHub and link it to the relevant issue.
|
||
2. Make sure to document your pull request with a clear description of what changes were made and why.
|
||
3. Wait for review and make any requested changes.
|
||
|
||
### 3. Creating New Modules
|
||
|
||
If you want to add a new module to Auto Archiver:
|
||
|
||
1. Ensure your module follows the existing [coding style and project structure](https://auto-archiver.readthedocs.io/en/latest/development/creating_modules.html).
|
||
2. Write clear documentation explaining what your module does and how to use it.
|
||
3. Ideally, include unit tests for your module!
|
||
4. Follow the steps in Section 2 to submit a pull request.
|
||
|
||
### 4. Do You Have Questions About the Source Code?
|
||
|
||
If you have any questions about how the source code works or need help using Auto Archiver
|
||
|
||
📝 Check the [Auto Archiver](https://auto-archiver.readthedocs.io/en/latest/) documentation.
|
||
|
||
👉 Ask your questions in the [Bellingcat Discord](https://www.bellingcat.com/follow-bellingcat-on-social-media/).
|
||
|
||
### 5. Do You Want to Contribute to the Documentation?
|
||
|
||
We welcome contributions to the documentation!
|
||
|
||
📖 Please read [Contributing to the Auto Archiver Documentation](https://auto-archiver.readthedocs.io/en/latest/development/docs.html) to learn how you can help improve the project's documentation.
|
||
|
||
------------------
|
||
|
||
Thank you for contributing to Auto Archiver! 🚀 |