Skip to content

docs: Add CONTRIBUTING.md with three core sections (Fixes #26) #49

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
sosal123tyu1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add CONTRIBUTING.md with three core sections (Fixes #26) #49

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
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Setup

To set up the environment, please ensure you have the required dependencies installed and run the installation script.

## Running the tests

You can verify your environment and the code by running the test suite. Use the following command:
`make test`

## Submitting a pull request

1. Fork the repository and create your feature branch.
2. Make your changes and ensure `make test` passes.
3. Submit a pull request and link any relevant issues.