Skip to content
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.

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

Update CONTRIBUTING.md #633

Merged
merged 2 commits into from
Oct 2, 2024
Merged
Changes from all commits
Commits
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
58 changes: 44 additions & 14 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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/[email protected]
```

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/).
Loading