Skip to content

Commit 1f0e695

Browse files
committed
docs: remove fork-pr instructions from CONTRIBUTING.md and MAINTENANCE.md
1 parent 2ec2dbd commit 1f0e695

File tree

2 files changed

+0
-102
lines changed

2 files changed

+0
-102
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,6 @@ Thank you for considering contributing to EigenLayer! This guide will help you s
44

55
## Setting Up Your Environment
66

7-
We use fork base PR mechanism. Contributions that do not follow our fork base PR practices will be automatically immediately closed and deleted, preventing branch pollution, keeping our repository clean, tidy, more readable and searchable.
8-
9-
### Fork and Clone the Repository
10-
11-
1. Fork the repository following [GitHub's instructions](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
12-
2. Clone your forked repository:
13-
14-
```bash
15-
git clone https://github.com/<your_github_id>/eigenlayer-contracts.git
16-
cd eigenlayer-contracts
17-
```
18-
197
### Install Dependencies
208

219
To set up this repo for the first time, run:
@@ -110,87 +98,8 @@ make storage-report
11098
------
11199

112100

113-
114101
## Submitting a Pull Request
115102

116-
117-
### Configure Remote Repositories
118-
119-
All PRs should be submitted from your forked repository. Add the official EigenLayer repository as your upstream remote:
120-
121-
```bash
122-
git remote add upstream https://github.com/Layr-Labs/eigenlayer-contracts.git
123-
```
124-
125-
Verify your configuration:
126-
127-
```bash
128-
git remote -v
129-
```
130-
131-
You should see:
132-
```
133-
origin https://github.com/<your_github_id>/eigenlayer-contracts.git (fetch)
134-
origin https://github.com/<your_github_id>/eigenlayer-contracts.git (push)
135-
upstream https://github.com/Layr-Labs/eigenlayer-contracts.git (fetch)
136-
upstream https://github.com/Layr-Labs/eigenlayer-contracts.git (push)
137-
```
138-
139-
140-
### Create Your PR to Upstream Branches
141-
142-
The following applies if you submit a PR to upstream branch of either `main` or `release-dev/*`, which will refer to as `<upstream-target-branch>`
143-
144-
Create a local branch from the upstream branch:
145-
146-
```
147-
git checkout -B <my-local-feature-branch> upstream/<upstream-target-branch>
148-
```
149-
150-
Make your changes, then commit:
151-
152-
```
153-
git add .
154-
git commit -m "your message"
155-
```
156-
157-
Push to your fork:
158-
159-
```
160-
git push -u origin <my-local-feature-branch>
161-
```
162-
163-
Go to GitHub, and open a PR from:
164-
165-
```
166-
your-fork:<my-local-feature-branch>
167-
**to**
168-
Layr-Labs/eigenlayer-contracts:<upstream-target-branch>
169-
```
170-
171-
GitHub should auto-detect this if branches match.
172-
173-
If you already have an open PR for this branch, just push more commits to `<my-local-feature-branch>`, and the PR will update.
174-
175-
176-
### Keeping Your Branch Updated With Upstream
177-
178-
To stay in sync with upstream's `<upstream-target-branch>`, whether it's `main` or `release-dev/*`:
179-
180-
```
181-
git fetch upstream
182-
git checkout <my-local-feature-branch>
183-
git rebase upstream/<upstream-target-branch>
184-
185-
# or use merge if you prefer
186-
# git merge upstream/<upstream-target-branch>
187-
188-
git push -f origin <my-local-feature-branch>
189-
```
190-
191-
Use --force only if you're rebasing (not with merges).
192-
193-
194103
### PR Title Format
195104

196105
Format your PR title as follows:

MAINTENANCE.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -142,17 +142,6 @@ So our release branch and model must be flexible enough to solve it via cherry p
142142
- all changes have to be deployed to testnet first, before mainnet. No skipping from preprod to mainnet directly
143143

144144

145-
### Release Branches
146-
147-
Once release are created, corresponding release branches will live forever for future reference and NEVER be deleted.
148-
149-
Together with “**Fork-based PR**” defined in CONTRIBUTING.md, it means there are only 3 categories of branches in the repository:
150-
151-
1. `main`: live forever, never delete
152-
2. release-dev branches `release-dev/*`: long living branch for release development with commits that should be all-or-nothing in `main`. They a period of time but will be deleted once their commits are merged back to `main`
153-
3. official release branches `vx.y.z`: live forever, never delete after a release is officially create
154-
155-
156145
### Changelog, Release Note, Release Announcement Blog
157146

158147
Each release in testnet and mainnet must have corresponding release note, changelog, and announcement blog

0 commit comments

Comments
 (0)