Contributing to csonpath

August 7, 2025 · View on GitHub

Thank you for considering contributing to csonpath! We welcome contributions from everyone—whether it's reporting bugs, writing tests, improving documentation, or suggesting new features.

🧑‍💻 How to Contribute

🐛 Bug Reports

  • Clearly describe the issue.
  • Include reproduction steps and environment details.
  • If possible, provide a minimal failing example.

✨ Feature Requests

  • Explain your use case.
  • Provide context and expected behavior.
  • Be open to feedback or refinement.

📘 Documentation

  • Improvements to README.md, examples are always helpful.
  • Keep the tone consistent with other OUTSCALE projects.

🧪 Tests

  • Adding tests to cover more scenarios is appreciated.

📦 Pull Requests

Please follow these guidelines:

  • Keep changes focused and scoped to a single purpose.
  • Run the make tests and validate behavior before submitting.
  • Use clear and descriptive commit messages.
  • Link related issues in your PR description.

✅ Code of Conduct

By participating, you agree to uphold our Code of Conduct.

Guidelines

  • Keep pull requests focused and atomic (one feature or fix per PR).
  • Follow any existing code style or formatting conventions.
  • Document your code where necessary.
  • Include tests when adding new logic (if applicable).
  • Use clear, meaningful commit messages (optionally following Conventional Commits and using Gitmoji for added clarity and consistency).

Questions?

If you have any questions or need help, feel free to open an issue or reach out to the maintainers on Discord.