From c4c76aac5683eb2a305b29914af999f1ba7b5961 Mon Sep 17 00:00:00 2001 From: Rafael Abuawad Date: Thu, 23 Feb 2023 23:30:58 -0400 Subject: [PATCH] Create CONTRIBUTING.md (#27) * Create CONTRIBUTING.md Add a `CONTRIBUTING.md` file * Adding feedback - Removing Code of Conduct - Removing Build references - Fixed Testing section - Added Linitng section - Added Fixed section --- CONTRIBUTING.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..d4afaaeae6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,78 @@ +# Contributing to hypersdk + +Thank you for your interest in contributing to `hypersdk`! By contributing to hypersdk, you are helping to build the foundation for the next generation of blockchains and decentralized applications. + +## Getting Started + +### Prerequisites + +To contribute to `hypersdk`, you'll need: + +- [Go](https://golang.org/dl/) 1.19 or higher + +### Setting up your development environment + +1. Clone the repository: + +```bash +git clone https://github.com/ava-labs/hypersdk.git +cd hypersdk +``` + +2. Install the dependencies: + +```go +go mod download +``` + +This will download and install all required dependencies for the project. + +## Building and running tests + +To build and run tests for the hypersdk, simply run: + +```go +./scripts/tests.unit.sh +``` + +This will build and run all tests for the project. + +## Running linters + +To run the linters, simply run: + +```go +./scripts/tests.lint.sh +``` + +This will run the linters on all code in the project. + +The `hypersdk` project also has a fixer that tries to help. To run the fixer, simply run: + +```go +./scripts/fix.lint.sh +``` + +## Contributing + +We welcome contributions to hypersdk! To contribute, please follow these steps: + +1. Fork the repository and create a new branch for your contribution. + +2. Make your changes and ensure that all tests pass and linting is clean. + +3. Write tests for any new features or bug fixes. (If necessary) + +4. Submit a pull request with your changes. + +## Pull Request Guidelines + +When submitting a pull request, please ensure that: + +1. Your code is formatted using `go fmt`. + +2. Your code is properly tested. + +3. Your code passes all linters. + +4. Your pull request description explains the problem and solution clearly.