From 022f9ec5142e878a72ae799613bd9e369d5728ae Mon Sep 17 00:00:00 2001 From: Priyank Makwana <117025290+RuneRogue@users.noreply.github.com> Date: Wed, 2 Oct 2024 20:23:15 +0530 Subject: [PATCH 1/2] Update CONTRIBUTING.md --- docs/CONTRIBUTING.md | 58 +++++++++++++++++++++++++++++++++----------- 1 file changed, 44 insertions(+), 14 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index f9c4445a..35b78cc9 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,25 +1,55 @@ # Contributors Guide -starknet.go is an open-source Golang Library for Cairo written by NethermindEth. -We welcome all contributions to this repository to help enrich the Starknet community. +**starknet.go** is an open-source Golang library for Cairo developed by NethermindEth. We welcome all contributions to this repository to help enrich the Starknet community. ## How to Contribute -We operate and maintain this project with an issue and pull request model. We will track -the GitHub issues section [Issues](https://github.com/NethermindEth/starknet.go/issues) of this repository -and contributors can submit [Pull -Requests](https://github.com/NethermindEth/starknet.go/pulls) for review by the maintainers. +We operate and maintain this project using an issue and pull request model. Please track the GitHub issues section [Issues](https://github.com/NethermindEth/starknet.go/issues) of this repository, and contributors can submit [Pull Requests](https://github.com/NethermindEth/starknet.go/pulls) for review by the maintainers. ### General Work-Flow - We recommend the following work-flow for contributors: +We recommend the following work-flow for contributors: - 1. **Find an issue** to work on and use comments to communicate your intentions and ask questions. - 2. **Work in a feature branch** of your personal fork (github.com/YOUR_NAME/starknet.go) of the main repository (github.com/NethermindEth/starknet.go). - 3. After you have implemented or resolved the issue, **create a pull-request** to merge your changes in the main repository - 4. Wait for the repository maintainers to **review your changes** to ensure the issue is addressed. - 5. If the issue is addressed the repository maintainers will **merge your pull-request** +1. **Find an issue** to work on and use comments to communicate your intentions and ask questions. +2. **Work in a feature branch** of your personal fork (github.com/YOUR_NAME/starknet.go) of the main repository (github.com/NethermindEth/starknet.go). +3. After you have implemented or resolved the issue, **create a pull request** to merge your changes into the main repository. +4. Wait for the repository maintainers to **review your changes** to ensure the issue is addressed. +5. If the issue is resolved, the repository maintainers will **merge your pull request**. -### Helpful Article on contribution +### Linter Checks -[guide](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/) +**starknet.go** now requires linter checks to pass. Please follow these steps to install and run the linter: + +1. **Install `golangci-lint`:** + + ```bash + go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.60.3 + ``` + +2. **Run the linter:** + + ```bash + golangci-lint run + ``` + + Ensure that there are no linter errors before submitting your pull request. + +3. **Run the linter on a specific file in a specific directory:** + + To run the linter on a specific file, use: + + ```bash + golangci-lint run path/to/your/file.go + ``` + + To run the linter on all files in a specific directory, use: + + ```bash + golangci-lint run path/to/your/directory + ``` + + Replace `path/to/your/file.go` and `path/to/your/directory` with the actual file and directory paths. + +### Helpful Article on Contribution + +For a detailed guide on contributing to a GitHub project, check out this [guide](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/). From 9d50a597c5e1766e2e7cb2f7e12f20972d897f97 Mon Sep 17 00:00:00 2001 From: Thiago Ribeiro <62709592+thiagodeev@users.noreply.github.com> Date: Wed, 2 Oct 2024 12:07:04 -0300 Subject: [PATCH 2/2] Update lint to the version currently used in CI --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 35b78cc9..8690fe7c 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -23,7 +23,7 @@ We recommend the following work-flow for contributors: 1. **Install `golangci-lint`:** ```bash - go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.60.3 + go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.60.0 ``` 2. **Run the linter:**