From 94f17e68e6a18846247dac389700f70a46d94daa Mon Sep 17 00:00:00 2001 From: "Thomas A. Christensen II" <25492070+MillironX@users.noreply.github.com> Date: Mon, 4 Apr 2022 11:13:54 -0500 Subject: [PATCH] Add contributing guidelines Signed-off-by: Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com> --- CONTRIBUTING.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9909a4d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,65 @@ +# Contributing to Kelpie.jl + +Thanks for pitching in to Kelpie. Here's a basic outline of how we muster the +mob of ideas and code from everyone into a single package. + +## Step 1. Check for a reported issue + +If you have a problem with or suggestion for Kelpie, check to see if someone +else has the same or a similar idea on our [Issues page]. If that issue exists, +use a [GitHub reaction] to support it. If you can't find anything similar, + +## Step 2. Open a new issue + +Open a [new issue], and follow the template for your type of issue (there are +separate templates for suggestions and bugs). + +## Step 3. Fork the repo + +If you think you can solve an issue, then [fork] the MillironX/Kelpie.jl repo to +your own GitHub account. To keep things, clean, please [create a new branch] for +your work. + +## Step 4. Code + +There are many ways to code on a Julia package. This is my favorite, and there +are dot files in the repo to support it. + +1. Install [Visual Studio Code] +2. Clone your fork of the repo +3. Open the package folder in VSCode +4. [Install the recommended extensions] +5. Checkout your branch +6. Press Alt+J, Alt+O to launch an + integrated Julia REPL +7. Press ], and then type `activate .` ENTER `instantiate` + ENTER BACKSPACE + +Of note while you code: + +- We use the [Blue style] for Julia files + +## Step 5. Add or update tests + +Make sure that your code passes all the current tests by using the REPL `] test` +command. If you change functionality, please add tests for that functionality to +the `test/runtests.jl` file. + +## Step 6. Update the Changelog + +Add a note to the `CHANGELOG.md` file under the "Unreleased" header indicating +what kind of change you made. See for the required +format. + +## Step 7. Pull request + +Submit a pull request against the `master` branch and wait for it to be merged. + +[blue style]: https://github.com/invenia/BlueStyle +[create a new branch]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch +[fork]: https://github.com/MillironX/Kelpie.jl/fork +[github reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ +[install the recommended extensions]: https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions +[issues page]: https://github.com/MillironX/Kelpie.jl/issues +[new issue]: https://github.com/MillironX/Kelpie.jl/issues/new/choose +[visual studio code]: https://code.visualstudio.com