From e26d1e0ba83111bef20c92012578164a7ee54e76 Mon Sep 17 00:00:00 2001 From: leroy0715 <40634737+leroy0715@users.noreply.github.com> Date: Thu, 5 Feb 2026 09:29:09 +0100 Subject: [PATCH] Create CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added CONTRIBUTING.md with instructions for future contributors. The file describes the forking process, branch creation, formatting requirements, and a PR checklist—this should reduce the number of questions and speed up reviews. --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md 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!