You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,25 +13,25 @@ In addition, we include top-level sections for Tools and Tutorials to support de
13
13
14
14
### Getting started
15
15
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:
19
19
-**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.
21
21
-**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/).
23
23
24
24
### Creating a pull request
25
25
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.
28
28
3.**Responsibility**: Contributors are expected to maintain their contributions over time and update them as necessary to ensure continued accuracy and relevance.
29
29
30
30
### Best practices
31
31
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.
35
35
36
36
37
37
## Running locally
@@ -45,14 +45,14 @@ Before running the site locally, you need to have the following installed:
45
45
46
46
### Setup
47
47
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.
0 commit comments