Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

84 lines (59 loc) · 2.67 KB

Contributing to WhatsApp Group Activity Summary

First off, thank you for considering contributing to this project! 🎉

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if possible

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When you are creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead
  • Explain why this enhancement would be useful

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible
  • Follow the Python styleguides
  • Include thoughtfully-worded, well-structured tests
  • Document new code
  • End all files with a newline

Development Process

  1. Fork the repo
  2. Create a new branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run the tests
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Setup Development Environment

# Clone your fork
git clone https://github.com/your-username/whatsapp-crew.git

# Add upstream remote
git remote add upstream https://github.com/original-owner/whatsapp-crew.git

# Install dependencies
crewai install

Running Tests

crewai test

Style Guidelines

  • Use Black for Python code formatting
  • Follow PEP 8 style guide
  • Write docstrings for all public modules, functions, classes, and methods
  • Comment your code where necessary

Additional Notes

  • If you find yourself wishing for a feature that doesn't exist, you are probably not alone
  • Feel free to ask for help; everyone is a beginner at first
  • Be welcoming to newcomers and encourage new contributors

Thank you for contributing! 🙏