Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
108 lines (82 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

108 lines (82 loc) · 2.41 KB

Contributing to Tamil Panchang API

Thank you for your interest in contributing! We welcome all contributions to the Tamil Panchang API project.

Getting Started

  1. Fork the Repository

    git clone https://github.com/YOUR-USERNAME/tamil-panchang-api.git
cd tamil-panchang-api

  2. Create a Feature Branch

    git checkout -b feature/your-feature-name

  3. Make Your Changes

    • Write clear, descriptive commit messages
    • Test your changes thoroughly
    • Follow the existing code style

  4. Commit Your Changes

    git add .
git commit -m "Add meaningful commit message"

  5. Push to Your Fork

    git push origin feature/your-feature-name

  6. Open a Pull Request

    • Provide a clear description of your changes
    • Reference any related issues
    • Ensure all tests pass
    • Wait for code review

Pull Request Requirements

Before submitting a pull request, ensure:

✅ Code Quality

  • Your code follows the project's style guidelines
  • All tests pass locally
  • No linting errors
  • Documentation is updated

✅ Testing

  • Add tests for new features
  • Ensure existing tests still pass
  • Test your changes thoroughly

✅ Documentation

  • Update README if needed
  • Add docstrings to new functions
  • Update CHANGELOG if applicable

✅ Branch Protection Rules

  • At least 1 approving review required
  • All status checks must pass
  • All conversations must be resolved

Types of Contributions

Bug Reports

  • Use the issue tracker
  • Describe the bug clearly
  • Include steps to reproduce
  • Specify your environment

Feature Requests

  • Clearly describe the feature
  • Explain the use case
  • Provide examples if possible
  • Discuss implementation approach

Code Contributions

  • Follow existing code patterns
  • Write clean, maintainable code
  • Include appropriate tests
  • Update documentation

Documentation

  • Fix typos and unclear explanations
  • Add examples
  • Improve API documentation
  • Create usage guides

Code of Conduct

  • Be respectful and inclusive
  • Welcome diverse perspectives
  • Give credit where it's due
  • Report inappropriate behavior

Questions?

  • Check existing issues and discussions
  • Open an issue with your question
  • Read the API documentation at /docs

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to Tamil Panchang API!