Skip to content

Commit

Permalink
Add contributing instructions to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mrandri19 committed Jun 14, 2020
1 parent 07addeb commit 9b1b0f2
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 9b1b0f2

Please sign in to comment.