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: CONTRIBUTING.md
+5-3
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,6 @@ The Documentation team at Avail are the primary maintainers of the Avail Documen
4
4
5
5
> ℹ️ Please make sure to create an issue outlining your feedback/content request for the docs before creating a PR.
6
6
> PRs created without approval will be closed. We are open to technical articles on a wide variety of topics related to Avail and Web3 in general. If you have something in mind, please feel free to jump in with an issue on the repo.
7
-
<!-- TOC -->
8
7
9
8
## How to Contribute Changes via the Avail Documentation Website
10
9
@@ -17,7 +16,9 @@ Contributing to the Avail Documentation is simple. You'll need a GitHub account
17
16
5.**Initiate Pull Request**: Scroll to the bottom and click on **Create pull request**.
18
17
6.**Title Your PR**: Give your pull request a descriptive title. For example, if you're editing the "Getting Started" page, you could title it _Update /docs/getting-started.md_.
19
18
7.**Describe Changes**: In the pull request description, specify the issue your changes resolve.
19
+
20
20
> See [GitHub Docs on Linking a Pull Request to an Issue](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) for guidance.
21
+
21
22
8.**Additional Information**: Provide a concise summary of the changes you've made. Include screenshots or references if applicable.
22
23
9.**Submit**: Click **Propose changes** to finalize your pull request. This will create a new branch in your fork.
23
24
@@ -38,6 +39,7 @@ Contributing to the Avail Documentation is simple. You'll need a GitHub account
38
39
```bash
39
40
git clone https://github.com/Genesis3800/docs.git
40
41
```
42
+
41
43
This will create a repo named `docs` in your current directory.
42
44
43
45
3.**Navigate to the Repository**
@@ -80,8 +82,8 @@ Contributing to the Avail Documentation is simple. You'll need a GitHub account
80
82
pnpm run dev
81
83
```
82
84
83
-
This will start a local dev derver at `http://localhost:3000` on your machine.
85
+
This will start a local dev derver at `http://localhost:3000` on your machine.
84
86
85
87
## License
86
88
87
-
The Avail Project Developer Documentation is licensed under the [MIT License](./LICENSE) free software license.### How to Contribute Changes via the Avail Documentation Website
89
+
The Avail Project Developer Documentation is licensed under the [MIT License](./LICENSE) free software license.### How to Contribute Changes via the Avail Documentation Website.
0 commit comments