Skip to content

Commit 3154ede

Browse files
committed
docs: refactor contributing
1 parent c19f0c7 commit 3154ede

File tree

1 file changed

+18
-31
lines changed

1 file changed

+18
-31
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
1-
### Getting Started
1+
# Getting Started
22

3-
#### 1. **Installation**
3+
## How to contribute
44

5-
- **Prerequisites**: Before diving in, ensure you have the necessary tools installed. Check out the [Prerequisites](#prerequisites) section for guidance.
6-
7-
- **Clone the Repository**:
5+
Found an issue you're passionate about? Comment with `"I'd like to tackle this!"` to claim it. Once assigned, you can begin your work. After completing your contribution, submit a pull request for review. Our team and other contributors will be able to provide feedback, and once approved, your contribution will be merged.
86

9-
```shell
10-
git clone [REPO_URL]
11-
cd lambda_ethereum_consensus
12-
```
7+
Please adhere to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification when crafting PR titles. Also, run `make fmt` to format source code according to the configured style guide. The repo enforces these automatically via GitHub Actions.
138

14-
- **Setup**: Once you've cloned the repository, follow the steps in the [Installing and running](#installing-and-running) section to set up your environment.
9+
> [!IMPORTANT]
10+
> We believe in fostering an inclusive, welcoming, and respectful community. All contributors are expected to adhere to our [Code of Conduct](#code-of-conduct). Please familiarize yourself with its contents before participating.
1511
16-
#### 2. **Prerequisite Knowledge**
12+
## Prerequisite Knowledge
1713

1814
To contribute effectively, you'll need a foundational understanding of both the Ethereum protocol and the Elixir language, including the Erlang VM (BEAM). If you're new to these areas, we've curated a list of resources to get you started:
1915

@@ -77,52 +73,43 @@ Truly mastering the Ethereum protocol is a complex endeavor. The list provided h
7773

7874
If you come across any resource that you find invaluable and believe should be added to this list, please don't hesitate to suggest its inclusion.
7975

80-
#### 3. **Dive In**
76+
## Dive In
8177

8278
With your newfound knowledge, explore the various areas of our project. Whether you're interested in the core consensus layer, networking, CLI, documentation, testing, or tooling, there's a place for you.
8379

8480
Start by browsing our [issues](https://github.com/lambdaclass/lambda_ethereum_consensus/issues), especially those tagged as `good first issue`. These are beginner-friendly and a great way to familiarize yourself with our codebase.
8581

86-
### How to contribute
87-
88-
Found an issue you're passionate about? Comment with `"I'd like to tackle this!"` to claim it. Once assigned, you can begin your work. After completing your contribution, submit a pull request for review. Our team and other contributors will be able to provide feedback, and once approved, your contribution will be merged.
89-
90-
Please adhere to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification when crafting PR titles. Also, run `make fmt` to format source code according to the configured style guide. The repo enforces these automatically via GitHub Actions.
91-
92-
> [!IMPORTANT]
93-
> We believe in fostering an inclusive, welcoming, and respectful community. All contributors are expected to adhere to our [Code of Conduct](#code-of-conduct). Please familiarize yourself with its contents before participating.
94-
95-
### Communication
82+
## Communication
9683

9784
**Open communication** is key to the success of any project. We encourage all contributors to join our [Telegram chat](https://t.me/lambdaconsensus) for real-time discussions, updates, and collaboration.
9885

9986
**For more structured discussions or proposals**, consider opening an issue or a discussion on the GitHub repository.
10087

101-
### Recognition
88+
## Recognition
10289

10390
We value every contribution, no matter how small. All contributors will be recognized in our project's documentation. Additionally, consistent and significant contributors may be offered more formal roles within the project over time.
10491

105-
### Support
92+
## Support
10693

10794
If you encounter any issues or have questions, don't hesitate to reach out. Our team and the community are here to help. You can ask questions in our Telegram chat or open an issue on GitHub for technical challenges.
10895

109-
### Conclusion
96+
## Conclusion
11097

11198
Lambda Ethereum Consensus is more than just a project; it's a community-driven initiative to bring the power and reliability of Elixir to the Ethereum ecosystem. With your help, we can make this vision a reality. Dive in, contribute, learn, and let's shape the future of Ethereum together!
11299

113100
---
114101

115102
**Thank you for being a part of our journey. Let's build an amazing future for Ethereum together! 🚀🌍**
116103

117-
## Code of Conduct
104+
# Code of Conduct
118105

119-
### Our Pledge
106+
## Our Pledge
120107

121108
We, as members, contributors, and leaders of open source communities and projects pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
122109

123110
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community and project.
124111

125-
### Our Standards
112+
## Our Standards
126113

127114
Examples of behavior that contributes to a positive environment for our community include:
128115

@@ -140,16 +127,16 @@ Examples of unacceptable behavior include:
140127
- Publishing others' private information, such as a physical or electronic address, without their explicit permission.
141128
- Other conduct which could reasonably be considered inappropriate in a professional setting.
142129

143-
## Enforcement Responsibilities
130+
# Enforcement Responsibilities
144131

145132
Maintainers are responsible for clarifying and enforcing standards of acceptable behavior and will take appropriate and fair corrective action.
146133

147134
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for behaviors that they deem inappropriate, threatening, offensive, or harmful.
148135

149-
## Enforcement
136+
# Enforcement
150137

151138
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported with proof to the maintainers through Telegram. All complaints will be reviewed and investigated promptly, fairly and anonymously.
152139

153-
## Attribution
140+
# Attribution
154141

155142
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html), version 2.1.

0 commit comments

Comments
 (0)