Skip to content

Create CONTRIBUTING.md #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leroy0715 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create CONTRIBUTING.md #296

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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!