Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (54 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

68 lines (54 loc) · 1.96 KB
Raw

Contributing to Ultimate SEO Analyzer API

🎉 First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes.

How Can I Contribute?

🐞 Reporting Bugs

  • Use the Issues tab on GitHub.
  • Include as many details as possible (URL, steps to reproduce, expected vs. actual behavior).
  • Attach screenshots or logs if relevant.

💡 Suggesting Enhancements

  • Open a new Discussion (General) or Issue.
  • Clearly describe the enhancement and why it would be useful.
  • If possible, propose an API design or example response.

🔧 Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature/my-new-feature
  3. Make your changes and ensure the code is clean.
  4. Test your changes (locally or via the deployed API).
  5. Commit with a clear message: 
    git commit -m "Add feature: XYZ"
  6. Push to your fork and open a Pull Request.

📐 Code Style

  • Follow Python PEP8 guidelines.
  • Keep functions small and readable.
  • Add docstrings where needed.
  • Use black or flake8 for formatting/linting (recommended).

📚 Documentation

  • If you add/change an endpoint, update the Wiki and README if needed.
  • Example responses should be updated in RapidAPI docs.

🚀 Getting Started for Development

  1. Clone the repository: 
    git clone https://github.com/YOUR_USERNAME/seo-analyzer-api.git
cd seo-analyzer-api
  2. Install dependencies: 
    pip install -r requirements.txt
  3. Run locally: 
    uvicorn main:app --reload

📝 Additional Notes

  • Be respectful and follow our Code of Conduct.
  • All contributions (code, issues, comments) are welcome!

Thank you for contributing ❤️