Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Contributor's Guide in Docs + CONTRIBUTING.md #204

Merged
merged 6 commits into from
Mar 5, 2021

Conversation

navidcy
Copy link
Member

@navidcy navidcy commented Mar 4, 2021

This PR adds a Contributor's guide. Mostly I followed the Oceananigans.jl guide as a "template".

(This PR addresses partially a review remark by @ranocha; see openjournals/joss-reviews#3053 (comment).)

Closes #180.

@navidcy navidcy marked this pull request as ready for review March 4, 2021 20:37
@navidcy navidcy changed the title [WIP] Adds Contributor's Guide in Docs + CONTRIBUTING.md Adds Contributor's Guide in Docs + CONTRIBUTING.md Mar 4, 2021
@navidcy
Copy link
Member Author

navidcy commented Mar 4, 2021

PR is ready for review :)

To view the Contributors guide in the Docs you need to build the Docs locally. Use

julia --project=docs/ -e 'using Pkg; Pkg.instantiate(); Pkg.develop(PackageSpec(path=pwd()))'; julia --project=docs/ docs/make.jl

and then open docs/build/contributing.html.

CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Hendrik Ranocha <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Contributors Section in Docs
2 participants