Skip to content

Commit 8215c41

Browse files
authored
Merge pull request #136 from IntersectMBO/chore/update-the-contributing.md
chore: updating contribution guide
2 parents dde27a7 + 5d0aa08 commit 8215c41

2 files changed

Lines changed: 20 additions & 14 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -104,20 +104,20 @@ docs/
104104

105105
### Submission Process
106106

107-
#### For Small Changes
108-
1. Fork the repository
109-
2. Create a feature branch: `git checkout -b fix/update-documentation`
110-
3. Make your changes
111-
4. Test locally: `npm start`
112-
5. Commit with descriptive message: `git commit -m "Fix typo in environment setup guide"`
113-
6. Push to your fork: `git push origin fix/update-documentation`
114-
7. Create a Pull Request
115-
116-
#### For Large Changes
117-
1. **First, create an issue** to discuss the proposed changes
118-
2. Get feedback from maintainers
119-
3. Follow the same process as small changes
120-
4. Reference the issue in your PR description
107+
1. **Discuss Proposed Changes**:
108+
- **Create an Issue**: First, create a GitHub issue to propose your changes.
109+
- **Contact a Developer Advocate**: Reach out to a Developer Advocate (e.g., in the Intersect Discord #developer-experience channel) to discuss the relevance and scope of the work.
110+
111+
2. **Agreement & Timeline**:
112+
- Work should typically not begin until there is an agreement on the scope.
113+
- **Timeline**: Timelines can be discussed, but **one week** is the standard duration for submitting a Pull Request (PR) after agreement.
114+
115+
3. **Implementation**:
116+
- Fork the repository and create a feature branch.
117+
- Make your changes and test locally.
118+
119+
4. **Submit Pull Request**:
120+
- Create your PR and ensure it is linked to the issue.
121121

122122
### Pull Request Guidelines
123123

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,17 @@ Meet and connect with our past and present developer advocates:
3737
- **Current Cohort**:
3838
- [Uche](https://www.linkedin.com/in/thisisobate)
3939
- Schedule a call with Uche [here](https://calendar.app.google/6HC9yHfTHrQ1dfcB9)
40+
- Discord: @obate.
4041
- [Emmanuel](https://www.linkedin.com/in/emmanuel-shikuku-devops/)
42+
- X (Twitter): [@Emmanuel_tyty](https://x.com/Emmanuel_tyty)
43+
- Discord: @emmanueltyty
44+
- Schedule a call with Emmanuel [here](https://calendar.app.google/3LGaFshgi7q9fsQD8)
4145
- [Dan](https://www.linkedin.com/in/danbaruka/)
4246
- X (Twitter): [@danamphred](https://x.com/danamphred)
47+
- Discord: @danamphred
4348
- Schedule a call with Dan [here](https://calendar.app.google/Ry32VJXbdgazUFe79)
4449
- [Harun](https://www.linkedin.com/in/harunslinked/)
50+
- Discord: @wesh09
4551
- Schedule a call with Harun [here](https://calendly.com/harunm28/30min)
4652
- **Past Cohort**:
4753
1. **Alex**

0 commit comments

Comments
 (0)