Skip to content

Commit

Permalink
Add contributing rules (scaffold-eth#1031)
Browse files Browse the repository at this point in the history
Co-authored-by: Carlos Sánchez <oceanrdn@gmail.com>
  • Loading branch information
Pabl0cks and carletex authored Jan 14, 2025
1 parent 25f23f6 commit fe40d3b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,19 @@ Read the [README](README.md) to get an overview of the project.

The goal of Scaffold-ETH 2 is to provide the primary building blocks for a decentralized application.

The repo can be forked to include integrations and more features, but we want to keep the master branch simple and minimal.
The repo can be forked to include integrations and more features, but we want to keep the `main` branch simple and minimal.

### Project Status

The project is under active development.

You can view the open Issues, follow the development process and contribute to the project.
You can view the open Issues, follow the development process, and contribute to the project.

### Rules

1. All code contributions require an Issue to be created and agreed upon by core contributors before submitting a Pull Request. This ensures proper discussion, alignment, and consensus on the proposed changes.
2. Contributors must be humans, not bots.
3. First-time contributions must not contain only spelling or grammatical fixes.

## Getting started

Expand Down Expand Up @@ -56,7 +62,7 @@ Some tips to follow when you are creating an issue:

- Provide as much context as possible. Over-communicate to give the most details to the reader.
- Include the steps to reproduce the issue or the reason for adding the feature.
- Screenshots, videos etc., are highly appreciated.
- Screenshots, videos, etc., are highly appreciated.

### Pull Requests

Expand All @@ -80,7 +86,7 @@ Here are some tips for a high-quality pull request:

Once you submit your PR:

- We may ask questions, request additional information or ask for changes to be made before a PR can be merged. Please note that these are to make the PR clear for everyone involved and aims to create a frictionless interaction process.
- We may ask questions, request additional information, or ask for changes to be made before a PR can be merged. Please note that these are to make the PR clear for everyone involved and aim to create a frictionless interaction process.
- As you update your PR and apply changes, mark each conversation resolved.

Once the PR is approved, we'll "squash-and-merge" to keep the git commit history clean.

0 comments on commit fe40d3b

Please sign in to comment.