-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Jul 17, 2023
1 parent
5a5c18a
commit c7c8822
Showing
52 changed files
with
70 additions
and
70 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Contributing · Vlasiator.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://henry2004y.github.io/Vlasiator.jl/contributing/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script><link href="../democards/gridtheme.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="Vlasiator.jl logo"/></a><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../manual/">User Guide</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../python/">Calling from Python</a></li><li><a class="tocitem" href="../gallery/">Gallery</a></li><li><a class="tocitem" href="../benchmark/">Benchmarks</a></li><li><a class="tocitem" href="../internal/">API Reference</a></li><li class="is-active"><a class="tocitem" href>Contributing</a><ul class="internal"><li><a class="tocitem" href="#Reporting-issues"><span>Reporting issues</span></a></li><li><a class="tocitem" href="#Feature-requests"><span>Feature requests</span></a></li><li><a class="tocitem" href="#Code-contribution"><span>Code contribution</span></a></li></ul></li><li><a class="tocitem" href="../log/">FAQ</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Contributing</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Contributing</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/henry2004y/Vlasiator.jl/blob/master/docs/src/contributing.md#L" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Contributing"><a class="docs-heading-anchor" href="#Contributing">Contributing</a><a id="Contributing-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing" title="Permalink"></a></h1><ul><li>Try to explain your contribution with simple language.</li><li>References are always welcome.</li><li>Follow the coding standards in the source.</li></ul><h2 id="Reporting-issues"><a class="docs-heading-anchor" href="#Reporting-issues">Reporting issues</a><a id="Reporting-issues-1"></a><a class="docs-heading-anchor-permalink" href="#Reporting-issues" title="Permalink"></a></h2><p>If you are experiencing issues or have discovered a bug, please <a href="https://github.com/henry2004y/Vlasiator.jl/issues">report it on GitHub</a>. To make the resolution process easier, please include the version of Julia and Vlasiator.jl in your writeup. These can be found with two commands:</p><pre><code class="language-julia hljs">julia> versioninfo() | ||
| julia> using Pkg; Pkg.status()</code></pre><h2 id="Feature-requests"><a class="docs-heading-anchor" href="#Feature-requests">Feature requests</a><a id="Feature-requests-1"></a><a class="docs-heading-anchor-permalink" href="#Feature-requests" title="Permalink"></a></h2><p>If you have suggestions of improvement or algorithms that you would like to see implemented in Vlasiator.jl, please open an <a href="https://github.com/henry2004y/Vlasiator.jl/issues">issue</a> on GitHub. Suggestions as well as feature requests are very welcome.</p><h2 id="Code-contribution"><a class="docs-heading-anchor" href="#Code-contribution">Code contribution</a><a id="Code-contribution-1"></a><a class="docs-heading-anchor-permalink" href="#Code-contribution" title="Permalink"></a></h2><p>If you have code that you would like to contribute to Vlasiator.jl, that is awesome! Please open an <a href="https://github.com/henry2004y/Vlasiator.jl/issues">issue</a> before you create the pull request on GitHub so that we make sure your idea is aligned with our goals for the project.</p><p>After your idea is discussed and revised by maintainers, please get the development version of the project by typing the following in the package manager:</p><pre><code class="language-julia hljs">] activate @dev</code></pre><p>This will create a fresh environment called <code>@dev</code> where you can play with the project components without compromising your normal user environment.</p><pre><code class="language-julia hljs">] dev Vlasiator</code></pre><p>This will clone all the project components in your <code>~/.julia</code> folder so that you can modify it and submit a pull request on GitHub later. Don't hesitate to ask questions. We are looking forward to your contributions.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../internal/">« API Reference</a><a class="docs-footer-nextpage" href="../log/">FAQ »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 17 July 2023 08:33">Monday 17 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| julia> using Pkg; Pkg.status()</code></pre><h2 id="Feature-requests"><a class="docs-heading-anchor" href="#Feature-requests">Feature requests</a><a id="Feature-requests-1"></a><a class="docs-heading-anchor-permalink" href="#Feature-requests" title="Permalink"></a></h2><p>If you have suggestions of improvement or algorithms that you would like to see implemented in Vlasiator.jl, please open an <a href="https://github.com/henry2004y/Vlasiator.jl/issues">issue</a> on GitHub. Suggestions as well as feature requests are very welcome.</p><h2 id="Code-contribution"><a class="docs-heading-anchor" href="#Code-contribution">Code contribution</a><a id="Code-contribution-1"></a><a class="docs-heading-anchor-permalink" href="#Code-contribution" title="Permalink"></a></h2><p>If you have code that you would like to contribute to Vlasiator.jl, that is awesome! Please open an <a href="https://github.com/henry2004y/Vlasiator.jl/issues">issue</a> before you create the pull request on GitHub so that we make sure your idea is aligned with our goals for the project.</p><p>After your idea is discussed and revised by maintainers, please get the development version of the project by typing the following in the package manager:</p><pre><code class="language-julia hljs">] activate @dev</code></pre><p>This will create a fresh environment called <code>@dev</code> where you can play with the project components without compromising your normal user environment.</p><pre><code class="language-julia hljs">] dev Vlasiator</code></pre><p>This will clone all the project components in your <code>~/.julia</code> folder so that you can modify it and submit a pull request on GitHub later. Don't hesitate to ask questions. We are looking forward to your contributions.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../internal/">« API Reference</a><a class="docs-footer-nextpage" href="../log/">FAQ »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 17 July 2023 12:16">Monday 17 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.