diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..77e32ddb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing to clob-client + +Thank you for taking the time to contribute! + +## Getting Started + +1. Fork this repository and clone your fork. +2. Create a new branch for your change. +3. Make your changes with clear, well-documented commits. +4. Run existing tests and add new ones if applicable. + +## Coding Guidelines + +- Use the provided linting/formatting tools (`eslint`, `prettier`) before committing. +- Keep pull requests focused and as small as possible. +- Do not commit real API keys or secrets. + +## Pull Request Checklist + +- Explain why the change is needed and what it does. +- Reference any related issues. +- Ensure CI checks pass before requesting a review. + +We appreciate your help in improving this project!