how-to-submit.md

How to Submit a Methodology

This guide walks you through how to submit your methodology onto this WEATS document repository. The way this works in github is it creates a copy of the WEATS repository into your account. You will then make changes to your copy of the WEATS repository, and then submit a Pull Request, which represents a change that you would like to make to the primary WEATS repository.

1. Write up your methodology in whatever text document you are most comfortable with. Our document repository is this Github repository, which renders documents in a format called Markdown, so it would be easiest to write your methodology in that format. However, these instructions include a way to convert any text to markdown if you wrote them in Google Docs or Microsoft Word.

---

2. To submit your methodology, you will create a Pull Request on our WEATS github repository. The simplest way to do that is to first attempt to create a new file directly on the repository. You can do that by clicking the “+” Sign to the right of the “Go to file” button. Then click “Create new file”, as shown below.

---

3. A page will come up asking if you want to fork the repository. Click "Fork this repository" to continue.

---

4. You will end up with a page that allows you to paste in your methodology in markdown. If you wrote your methodology in Microsoft Word or Google Docs, you can use this website to convert it to Markdown.

Make sure to fill out the “Name your file” with a file that ends with the suffix “.md”. This will allow you to use the “Edit” and “Preview” button to toggle between the raw Markdown and how it will be rendered on Github.

Paste your methodology into the document. When you click Preview, you should see your methodology rendered in a way that resembles what it looked like in the Google Doc.

---

5. When you are done, click the green “Commit Changes…” button and a pop-up will appear. You don’t need to write anything in this description, a later step will provide an opportunity for you to explain your proposed methodology and any additional information you think reviewers might need. When you have completed this, click “Propose changes”

---

6. You will be redirected to a page that shows a summary of your changes, as well as a page that allows you to Create a pull request. Click the “Create pull request” button.

---

7. This will redirect you to a page that will allow you to add information that will be publicly shown alongside the methodology. This is where you can provide a summary of the methodology as well as any additional information you’d want reviewers to see. This can even include supplementary files. When you are done, click the “Create pull request” and a pull request will show up in the WEATS repository for review!

---

8. After clicking the “Create pull request” button, your Pull Request should show up on the WEATS Repository. You should be able to see it by clicking the “Pull Requests Tab”.

Thank you for submitting a methodology to the OpenEAC Alliance! The Steering Committee will reach out with next steps.