Create CONTRIBUTING.md #27
Conversation
Add a `CONTRIBUTING.md` file
CONTRIBUTING.md
Outdated
|
|
||
| This will download and install all required dependencies for the project. | ||
|
|
||
| 3. Build the project: |
There was a problem hiding this comment.
I don't think there is actually any artifact that is built here (as it is just an SDK).
There was a problem hiding this comment.
You are right! I just added It based on a template that I had. Thank you for the feedback!
CONTRIBUTING.md
Outdated
| To build and run tests for the hypersdk, simply run: | ||
|
|
||
| ```go | ||
| go test -timeout 30s ./... |
There was a problem hiding this comment.
To run unit tests, you should use:
./scripts/tests.unit.sh
CONTRIBUTING.md
Outdated
|
|
||
| ## Running linters | ||
|
|
||
| > TODO: How to lint and format |
There was a problem hiding this comment.
This is just:
./scripts/tests.lint.sh
There was a problem hiding this comment.
We also have a "fixer" that tries to help:
./scripts/fix.lint.sh
There was a problem hiding this comment.
Added, I wasn't sure about how to test everything. Didn't notice the scripts folder, thank you!
CONTRIBUTING.md
Outdated
|
|
||
| 4. Your pull request description explains the problem and solution clearly. | ||
|
|
||
| ## Code of Conduct |
There was a problem hiding this comment.
We don't have this yet, so we can probably just remove this section.
There was a problem hiding this comment.
Removed! Thank you
|
You may need to rebase this on |
- Removing Code of Conduct - Removing Build references - Fixed Testing section - Added Linitng section - Added Fixed section
|
Nice work @rafael-abuawad! |
Add a
CONTRIBUTING.mdfile