From 9b1b0f2543bf6479d394b6c1f5592d31a4f366bd Mon Sep 17 00:00:00 2001 From: Andrea Cognolato Date: Sun, 14 Jun 2020 18:17:54 +0200 Subject: [PATCH] Add contributing instructions to README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 9e3efc781..0ad5d51b4 100644 --- a/README.md +++ b/README.md @@ -49,3 +49,25 @@ The construction of a surrogate model can be seen as a three-step process: using Pkg Pkg.add("Surrogates") ``` + +## Contributing + +Here is the suggested workflow to contribute to this package: + +1. Fork the repository on github. (Click the `Fork` button in the top-right corner) + +2. Clone the repository you have just forked. `git clone https://github.com/YOUR_USERNAME/Surrogates.jl.git` + +3. Enter the repository's directory. `cd Surrogates.jl` + +4. Open the Julia REPL. `julia` + +5. Enter package mode and activate the local environment. `]activate .` + +6. Install the dependencies. `instantiate` + +7. Perform your edits (Atom with Juno, or VSCode with the Julia plugin are good editor choices) + +8. Stage, Commit, and Push your changes + +9. [Open a Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)