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.

Sign up for GitHub

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

Add contributing rules #1031

Merged
merged 2 commits into from
Jan 14, 2025
Merged

Add contributing rules #1031

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84f545e
Add contributing rules
Pabl0cks Jan 13, 2025
6a165cc
little tweaks
carletex Jan 13, 2025
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
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
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.
Loading