Skip to content

Commit 519ab72

Browse files
pepegalicAniket-Engg
authored andcommitted
docs: fix typos and grammatical errors
1 parent 7a2ad6c commit 519ab72

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

release-management.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Release managers are responsible for the release management lifecycle, focusing
66

77
## Pre release planning:
88
In this stage, release manager and the team lead will elaborate a plan for the coming release.
9-
This should take in account:
9+
This should take into account:
1010
- the current issues list (a fair amount of time should be taken to go over the github issues).
1111
- the current critical bugs.
1212
- the current roadmap.
@@ -27,8 +27,8 @@ We check all the issues and associated effort and identify critical issues.
2727
e.g:
2828
- issues that'll need to be split.
2929
- issues that miss important information.
30-
- issues that are dependent each others.
31-
- issued that require different skills or that the team member is less available during this release.
30+
- issues that are dependent on each others.
31+
- issues that require different skills or that the team member is less available during this release.
3232

3333
## Configuring releases:
3434
Release managers will oversee the various aspects of a project before it is due to be deployed, ensuring everyone is on track and meeting the agreed timeline.
@@ -56,7 +56,7 @@ The release manager is still responsible for ensuring a project is rolled out sm
5656
## Detailed Responsibilities:
5757

5858
- Lead the daily standup meeting.
59-
- 10 minutes or more are reserved at the end of the daily standup meeting where the release manager update the team on the opened PRs (PRs which aim to be delivered in the planned release).
59+
- 10 minutes or more are reserved at the end of the daily standup meeting where the release manager update the team on the open PRs (PRs which aim to be delivered in the planned release).
6060
- Regular check for new filed issues, identify those that require to be published (included in the release)
6161
- In some really specific situations, it could be required to deploy intermediate releases (e.g critical bug fixes).
6262
- Planning, refinement, retrospective meetings have to be organized by the release manager and any other required meetings.
@@ -80,7 +80,7 @@ The release manager is still responsible for ensuring a project is rolled out sm
8080

8181
### coding period
8282

83-
- [ ] 10 min after each daily standup where the release manager give an update of the current situation and ETA.
83+
- [ ] 10 min after each daily standup where the release manager gives an update of the current situation and ETA.
8484
- [ ] release manager should make sure to be aware of the current state of each issues and PRs during the coding period in order to have a better overview of who is working on what and best provide support to all the team members that are involved in the release.
8585

8686
### QA preparation

release-process.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This document includes the release instructions for:
99
- Updating Remix's beta version on remix-beta.ethereum.org
1010

1111
## Feature Freeze
12-
Once feature freeze is done, `remix_beta` should be updated latest to the master which will automatically update `remix-beta.ethereum.org` through a CI job.
12+
Once feature freeze is done, `remix_beta` should be updated to the latest master which will automatically update `remix-beta.ethereum.org` through a CI job.
1313

1414
Use this unified command:
1515

@@ -45,7 +45,7 @@ This command will ask for a new version.
4545

4646
### Other libraries NPM release
4747

48-
`yarn run publish:libs `
48+
`yarn run publish:libs`
4949

5050
This command uses `lerna` and is solely responsible for publishing all the remix libraries. It will ask for a new version of each library. Make sure you are logged in to NPM.
5151

team-best-practices.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ This document aims to address contributors best practices of the following repos
55
- Remix Project: https://github.com/ethereum/remix-project
66
- Remix Libraries: https://github.com/ethereum/remix-project/tree/master/libs
77

8-
This document is not in its final version, **a team meeting which aim to address new/old best practices, feedback, workflows, all kind of issues related to how the team work together occurs every 2 weeks.**
9-
This document link to other specialised best practices (like coding best practices).
8+
This document is not in its final version, **a team meeting which aims to address new/old best practices, feedback, workflows, all kind of issues related to how the team works together occurs every 2 weeks.**
9+
This document link to other specialized best practices (like coding best practices).
1010

1111
Related links:
1212
- Public Website: https://remix-project.org
@@ -38,7 +38,7 @@ Related links:
3838

3939
- A milestone standup - scheduled before the beginning of each milestone, roughly on a monthly basis - which aim to define what will be included in the **next milestone** and who will work on what. This standup also help to set a clear long term vision.
4040

41-
- A retrospective standup - after each releases - which aim to talk about **best practices in general**: what is good, what is bad, how we can improve workflows.
41+
- A retrospective standup - after each release - which aims to talk about **best practices in general**: what is good, what is bad, how we can improve workflows.
4242

4343
- A tour standup - Just after a release or whenever it is needed - which aim to demo, **explain in details** features, bug fixes or any part of the codebase.
4444

@@ -122,7 +122,7 @@ Before starting coding, we should ensure all devs / contributors are aware of:
122122
- The end of a milestone triggers a new release.
123123
- Milestone items and duration should take in account time spent in bugs fixing and support.
124124
- The team should commit to the milestone duration.
125-
- If a dev finish early he/she can help other to push remaining tasks.
125+
- If a dev finish early he/she can help others to push remaining tasks.
126126
- If a dev finish early he/she can work on specifying / integrating the next milestone.
127127
- A milestone duration is fixed at the start of the milestone (but should better not exceed 1 month).
128128
- Progress and issues regarding a milestone are discussed on regular standups.

0 commit comments

Comments
 (0)