Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (27 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

34 lines (27 loc) · 1.13 KB

Contributing to CodePulse

We welcome contributions! Whether you're fixing a bug, adding a new feature, or improving documentation, your help is appreciated.

How to Contribute

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/code-pulse.git
  3. Create a branch for your feature or fix: 
    git checkout -b feature/your-feature-name
  4. Make your changes. Ensure your code follows the existing style and is well-tested.
  5. Run tests: 
    uv run pytest
  6. Commit your changes. Please follow the Conventional Commits specification for commit messages.
  7. Push to your fork: 
    git push origin feature/your-feature-name
  8. Open a Pull Request to the main branch.

Attribution Requirement

Please note that as per our LICENSE, any modifications or updates made to CodePulse must include credit to Spectrayan.

Questions?

If you have any questions or need help, feel free to open an issue or contact us at support@spectrayan.com.