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
Revise contribution guide for clarity and inclusivity
Expanded instructions to clarify how to suggest corrections and add new pages. Added a welcoming introduction and guidance for contributors unfamiliar with GitHub, encouraging broader participation and making the process more accessible.
This section includes instructions for making a correction or an improvement to an existing page, as well as instructions on how to add a new page to add something new to the guide.
9
+
The OpenAT design guide is a living document. We welcome improvements from people with disabilities, makers, disability professionals, engineers, and anyone designing OpenAT. This section includes instructions for making a correction or an improvement to an existing page, as well as instructions on how to add a new page to add something new to the guide.
10
+
11
+
You can contribute in two main ways:
9
12
10
-
# Making a Correction
13
+
1.**Suggest a correction or improvement** (e.g., better dimensions, clearer instructions).
14
+
2.**Add a new page** for a component or design element that is missing.
11
15
12
-
This design guide is a living document, and can always be improved. If after testing a dimension or step in this guide, you find a better dimension or set of steps for a page in the guide, you can raise a github issue to change the dimension in the guide.
16
+
# Suggest a correction or improvement
17
+
18
+
If after testing a dimension or step in this guide, you find a better dimension or set of steps for a page in the guide, you can raise a GitHub issue to change the dimension in the guide.
19
+
20
+
To do so, click [this link](https://github.com/makersmakingchange/OpenAT_Design_Guide/issues). From here, click on the green 'New Issue' button at the top right. Give the issue a title that explains what feature in what part need to be changed (i.e., "Changing threaded hole diameter for #4 sheet metal screw") then fill out the issue description with more information about what you want to change, and why you think it needs changing.
13
21
14
-
To do so, click [this link](https://github.com/makersmakingchange/OpenAT_Design_Guide/issues). From here, click on the green 'New Issue' button at the top right. Give the issue a title that explains what feature in what part need to be changed (i.e. "Changing threaded hole diameter for #4 sheet metal screw") then fill out the issue description with more information about what you want to change, and why you think it needs changing.
15
22
16
23
# Adding a new page
17
24
18
-
If you have something that you think should be added to the design guide, you can create a push request to add a page to the guide.
25
+
If you have something that you think should be added to the design guide, you can create a pull request to add a page to the guide.
19
26
20
27
To do so, click [this link](https://github.com/makersmakingchange/OpenAT_Design_Guide/tree/Github-Pages-Version) to go to the project repository. Create a local copy of the repository, then copy the template.md file. Paste the copy into either the Commercial_Components folder or the Design_Elements_For_3D_Printed_Parts folder, depending on what you want to add to the guide. Once you have copied the template to the correct location, open the file and begin filling it out.
21
28
@@ -26,3 +33,8 @@ The first 6 lines are the header, which gives the page its title, parent page, a
26
33
Once you have created the page for your new entry, create a push request for the repository, and an MMC team member will review it and either add it to the guide, give feedback on what needs to be changed before adding it to the guide, or will not add it if the content is deemed inappropriate for the guide.
27
34
28
35
If you are unable to create a local version of the GitHub repo to modify the template file yourself, you can download and modify the template file as explained in the above instruction, then submit it through GitHub issues like in the Making a Correction section.
36
+
37
+
{: .note }
38
+
**Not comfortable with GitHub yet?**
39
+
40
+
That’s okay! You can still help. Open an issue describing your suggestion in plain language, or contact the Makers Making Change team with your notes, measurements, or photos. We can help turn it into a page in the guide.
0 commit comments