Skip to content

Commit 4111731

Browse files
committed
Sentence case
1 parent bda2092 commit 4111731

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,25 @@ In addition, we include top-level sections for Tools and Tutorials to support de
1313

1414
### Getting started
1515

16-
1. **Fork and Branch**: Fork the `main` branch into your own GitHub account. Create a feature branch for your changes.
17-
2. **Make Changes**: Implement your changes or additions in your feature branch.
18-
3. **Contribution Quality**: Ensure that your contributions are:
16+
1. **Fork and branch**: Fork the `main` branch into your own GitHub account. Create a feature branch for your changes.
17+
2. **Make changes**: Implement your changes or additions in your feature branch.
18+
3. **Contribution quality**: Ensure that your contributions are:
1919
- **Atomic**: Small, self-contained, logical updates are preferred.
20-
- **Well Documented**: Use clear commit messages. Explain your changes in the pull request description.
20+
- **Well documented**: Use clear commit messages. Explain your changes in the pull request description.
2121
- **Tested**: Verify your changes do not break existing functionality.
22-
- **Styled Correctly**: Follow the [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/).
22+
- **Styled correctly**: Follow the [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/).
2323

2424
### Creating a pull request
2525

26-
1. **Pull Request**: Once your changes are complete, create a pull request against the main branch of Polygon Technical Docs.
27-
2. **Review Process**: Your pull request will be reviewed by the maintainers. They may request changes or clarifications.
26+
1. **Pull request**: Once your changes are complete, create a pull request against the main branch of Polygon Technical Docs.
27+
2. **Review process**: Your pull request will be reviewed by the maintainers. They may request changes or clarifications.
2828
3. **Responsibility**: Contributors are expected to maintain their contributions over time and update them as necessary to ensure continued accuracy and relevance.
2929

3030
### Best practices
3131

32-
- **Stay Informed**: Keep up-to-date with the latest developments in Polygon technologies.
33-
- **Engage with the Community**: Participate in discussions and provide feedback on other contributions.
34-
- **Stay Consistent**: Ensure your contributions are coherent with the rest of the documentation and do not overlap or contradict existing content.
32+
- **Stay informed**: Keep up-to-date with the latest developments in Polygon technologies.
33+
- **Engage with the community**: Participate in discussions and provide feedback on other contributions.
34+
- **Stay consistent**: Ensure your contributions are coherent with the rest of the documentation and do not overlap or contradict existing content.
3535

3636

3737
## Running locally
@@ -45,14 +45,14 @@ Before running the site locally, you need to have the following installed:
4545

4646
### Setup
4747

48-
1. **Clone Repository**: Clone the Polygon Technical Docs repository to your local machine.
49-
2. **Create a Virtual Environment**: Run `virtualenv venv; source venv/bin/activate` in the root directory.
50-
3. **Install Dependencies**: Install required Python packages with `pip3 install -r requirements.txt`.
48+
1. **Clone repository**: Clone the Polygon Technical Docs repository to your local machine.
49+
2. **Create a virtual environment**: Run `virtualenv venv; source venv/bin/activate` in the root directory.
50+
3. **Install dependencies**: Install required Python packages with `pip3 install -r requirements.txt`.
5151

5252
### Running the website
5353

54-
1. **MkDocs in Strict Mode**: Use `mkdocs serve --strict` for a production-like environment.
55-
2. **MkDocs in Normal Mode**: Use `mkdocs serve` for a less strict, more forgiving environment, suitable for debugging.
54+
1. **MkDocs in strict mode**: Use `mkdocs serve --strict` for a production-like environment.
55+
2. **MkDocs in normal mode**: Use `mkdocs serve` for a less strict, more forgiving environment, suitable for debugging.
5656

5757
### Docker alternative
5858

0 commit comments

Comments
 (0)