From 036eec12cf24c2f042bbcdb298d9813efba5dc80 Mon Sep 17 00:00:00 2001 From: Amber Date: Thu, 17 Sep 2020 19:53:01 -0400 Subject: [PATCH] Docs: improve docs contrib --- .../ContributingDocumentation.mdr | 28 +++++++++++++++---- 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/Contributing/ContributingDocumentation.mdr b/docs/Contributing/ContributingDocumentation.mdr index 350d8285..1b745a1a 100644 --- a/docs/Contributing/ContributingDocumentation.mdr +++ b/docs/Contributing/ContributingDocumentation.mdr @@ -5,19 +5,26 @@ You might be here because you found something you could improve in [Gwion's documentation](https://github.com/fennecdjay/gwion-docs). Please open an [issue](https://github.com/fennecdjay/gwion-docs/issues) describing the problem and how you might address it. - ## Dependencies - * Gwion - * mdr - * MdBook +Technically none of these are *needed*, but they are quite useful: + +* Gwion +* mdr +* MdBook ## Editing the documentation +### Fork the repository + +You can do this through the github site, or command-line tools like `gh` or `hub`. See **Further Reading**. + ### Clone the source +Clone the url of your fork + ``` sh -git clone https://github.com/fennecdjay/gwion-docs +git clone https://github.com//gwion-docs ``` ### Edit some files @@ -40,5 +47,14 @@ git commit -m "Something meaningful about why we are here" git push ``` -You're now ready to submit a [PullRequest](https://github.com/fennecdjay/gwion-docs/pulls). +### Submit a pull request + +You can do this through the [github site](https://github.com/fennecdjay/gwion-docs/pulls), or command-line tools like `gh` or `hub`. See **Further Reading**. + +You can now sit back and wait for your pull request to be reviewed. If it's accepted, congrats! :tada: You've made a contribution! + +### Further reading + +For a more advanced info on contributing, check out @Chaser324's [GitHub Standard Fork & Pull Request Workflow](https://gist.github.com/Chaser324/ce0505fbed06b947d962). +For a guide on making a pull request, there's github's [Creating a pull request from a fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). -- 2.43.0