From b7d4773a85fcc9f9d4b8233d23e0371db016cedd Mon Sep 17 00:00:00 2001 From: Amber Date: Thu, 17 Sep 2020 21:38:46 -0400 Subject: [PATCH] populate contribcode w/ contribdocs --- docs/Contributing/ContributingCode.mdr | 56 +++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/docs/Contributing/ContributingCode.mdr b/docs/Contributing/ContributingCode.mdr index 212bedea..501d5ae4 100644 --- a/docs/Contributing/ContributingCode.mdr +++ b/docs/Contributing/ContributingCode.mdr @@ -1,3 +1,57 @@ # Contributing Code -> stub, to be filled +> this is a stub for now, this place deserves better + +You might be here because you found something you could improve in [Gwion](https://github.com/fennecdjay/gwion). +Please open an [issue](https://github.com/fennecdjay/gwion/issues) describing the problem and how you might address it. + +## Dependencies + +- + +## Editing the code + +### 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//gwion +``` + +### Edit some files + +``` sh +cd gwion +make watch +``` + +### Add your changes + +``` sh +git add docs/myfile.mdr +``` + +### Let the world know + +``` sh +git commit -m "Something meaningful about why we are here" +git push +``` + +### Submit a pull request + +You can do this through the [github site](https://github.com/fennecdjay/gwion/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