Skip to content

Commit cc0a19d

Browse files
docs: add contributing.md
1 parent 000fc6f commit cc0a19d

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
3+
## Maintainer
4+
5+
This project is maintained by the [Cardano Foundation](https://cardanofoundation.org).
6+
Current maintainer: [@VladislavKudrin](https://github.com/VladislavKudrin)
7+
8+
## Reporting Issues
9+
10+
Open a [GitHub issue](https://github.com/cardano-foundation/cardano-graphql/issues) with:
11+
- Steps to reproduce
12+
- Expected vs actual behavior
13+
- Environment (OS, Docker version, cardano-node/db-sync versions)
14+
15+
## Submitting Pull Requests
16+
17+
1. Fork the repository
18+
2. Create a branch from `master`
19+
3. Make your changes
20+
4. Ensure lint passes: `yarn workspaces run lint`
21+
5. Open a PR against `master`
22+
23+
## Running Locally
24+
25+
See [README.md](README.md) for setup instructions.
26+
27+
To run tests against a live preprod node:
28+
```bash
29+
GRAPHQL_URL=http://localhost:<port> yarn workspace @cardano-graphql/api-cardano-db-hasura test --forceExit
30+
```
31+
GraphQL golden tests (requires a running mainnet node):
32+
```bash
33+
cd tests
34+
uv run pytest
35+
```
36+
37+
## Code of Conduct
38+
39+
Please follow our [Code of Conduct](CODE-OF-CONDUCT.md).

0 commit comments

Comments
 (0)