Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (58 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

85 lines (58 loc) · 3.87 KB

Contributing to OpenSocialMonitor

First of all, thank you for considering contributing to OpenSocialMonitor! This project aims to provide transparency in social media manipulation, and every contribution helps make that goal a reality.

About the Maintainer

I'm passionate about combating misinformation and promoting transparency online, but I want to be upfront that my coding skills without AI assistance are limited. I'm learning as I go and rely on tools like Claude to help review and understand complex code.

What this means for contributors:

  • I review pull requests once a week (typically on weekends)
  • I may ask more questions to understand your code changes
  • Complex changes might take longer to review and merge
  • Your patience and clear explanations are greatly appreciated

I'm actively looking for co-maintainers and regular contributors with stronger technical skills to help this project reach its full potential. If you're interested in a more significant role in the project, please reach out!

How You Can Help

Code Contributions

  1. Bug fixes: Fixing issues in the existing codebase
  2. New features: Adding new functionality that aligns with the roadmap
  3. Platform support: Extending the tool to work with other social media platforms
  4. Performance improvements: Making the code more efficient and reliable
  5. Error handling: Improving how the tool handles edge cases and errors

Non-Code Contributions

  1. Documentation: Improving installation instructions, usage guides, and examples
  2. Testing: Using the tool and reporting issues or unexpected behavior
  3. Design: Creating visual assets, logos, or UI mockups for future versions
  4. Use cases: Sharing real-world applications and results from using the tool
  5. Community building: Helping answer questions from other users

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork to your local machine
  3. Create a new branch for your changes
  4. Make your changes and commit them
  5. Push your changes to your fork
  6. Submit a pull request to the main repository

Pull Request Process

  1. Ensure your code adheres to the project's style and structure
  2. Update documentation to reflect any changes you've made
  3. Include a clear description of what your changes do and why
  4. Link any related issues that your PR addresses
  5. Be responsive to feedback and questions about your contribution

Code Guidelines

  1. Keep code modular and organized in the established structure
  2. Add comments for complex logic or non-obvious functionality
  3. Include docstrings for functions and classes
  4. Add appropriate error handling for robust operation
  5. Follow existing code patterns for consistency

Communication

  • Issues: Use GitHub issues for bug reports, feature requests, or questions
  • Pull Requests: For code or documentation contributions
  • Discussions: For broader conversations about the project's direction

Review Schedule

I review contributions on a weekly basis, typically on weekends. If your pull request hasn't received a response within 7-10 days, feel free to comment on it as a gentle reminder.

Seeking Co-Maintainers

If you're interested in becoming a co-maintainer with more regular involvement in the project, please reach out via GitHub or email. Ideal co-maintainers would have:

  • Experience with Python and social media APIs
  • Interest in misinformation and social media manipulation
  • Time to review pull requests and help guide the project
  • A collaborative and respectful approach to open source

Code of Conduct

This project is committed to providing a welcoming and harassment-free experience for everyone. We expect all participants to adhere to respectful behavior and language.

Thank You

Your contributions help make social media more transparent and trustworthy. Thank you for being part of this important mission!