-
Notifications
You must be signed in to change notification settings - Fork 0
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
Aleksei Rubashev
committed
Jul 23, 2024
1 parent
86469b8
commit 268f0a1
Showing
19 changed files
with
173 additions
and
281 deletions.
There are no files selected for viewing
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,4 +1,4 @@ | ||
| # Sphinx build info version 1 | ||
| # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
| config: 615202bbcc5a71877ebb284d43bc6c7b | ||
| config: 7f5e2781b2e95fb6a27395ae1ad774ce | ||
| tags: 645f666f9bcd5a90fca523b33c5a78b7 |
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
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 |
|---|---|---|
|
|
@@ -9,7 +9,6 @@ Welcome to Global Logger's documentation! | |
| installation | ||
| usage | ||
| modules | ||
| contributing | ||
| authors | ||
| history | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,7 @@ | |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
|
|
||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>Contributing — Global Logger 0.4.0 documentation</title> | ||
| <title><no title> — Global Logger unknown documentation</title> | ||
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" /> | ||
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" /> | ||
|
|
||
|
|
@@ -15,7 +15,7 @@ | |
|
|
||
| <script src="_static/jquery.js?v=5d32c60e"></script> | ||
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> | ||
| <script src="_static/documentation_options.js?v=6c02275b"></script> | ||
| <script src="_static/documentation_options.js?v=3f1b9271"></script> | ||
| <script src="_static/doctools.js?v=9a2dae69"></script> | ||
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> | ||
| <script src="_static/js/theme.js"></script> | ||
|
|
@@ -37,7 +37,7 @@ | |
| Global Logger | ||
| </a> | ||
| <div class="version"> | ||
| 0.4.0 | ||
| unknown | ||
| </div> | ||
| <div role="search"> | ||
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> | ||
|
|
@@ -48,26 +48,11 @@ | |
| </div> | ||
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> | ||
| <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <ul class="current"> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="readme.html">Global Logger</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="modules.html">global_logger</a></li> | ||
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="#types-of-contributions">Types of Contributions</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="#report-bugs">Report Bugs</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="#fix-bugs">Fix Bugs</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="#implement-features">Implement Features</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="#write-documentation">Write Documentation</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="#submit-feedback">Submit Feedback</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#get-started">Get Started!</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#pull-request-guidelines">Pull Request Guidelines</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#tips">Tips</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#deploying">Deploying</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l1"><a class="reference internal" href="authors.html">Credits</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="history.html">History</a></li> | ||
| </ul> | ||
|
|
@@ -86,7 +71,7 @@ | |
| <div role="navigation" aria-label="Page navigation"> | ||
| <ul class="wy-breadcrumbs"> | ||
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> | ||
| <li class="breadcrumb-item active">Contributing</li> | ||
| <li class="breadcrumb-item active"><no title></li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| <a href="_sources/contributing.rst.txt" rel="nofollow"> View page source</a> | ||
| </li> | ||
|
|
@@ -96,123 +81,7 @@ | |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
| <div itemprop="articleBody"> | ||
|
|
||
| <section id="contributing"> | ||
| <h1>Contributing<a class="headerlink" href="#contributing" title="Link to this heading"></a></h1> | ||
| <p>Contributions are welcome, and they are greatly appreciated! Every little bit | ||
| helps, and credit will always be given.</p> | ||
| <p>You can contribute in many ways:</p> | ||
| <section id="types-of-contributions"> | ||
| <h2>Types of Contributions<a class="headerlink" href="#types-of-contributions" title="Link to this heading"></a></h2> | ||
| <section id="report-bugs"> | ||
| <h3>Report Bugs<a class="headerlink" href="#report-bugs" title="Link to this heading"></a></h3> | ||
| <p>Report bugs at <a class="reference external" href="https://github.com/alertua/global_logger/issues">https://github.com/alertua/global_logger/issues</a>.</p> | ||
| <p>If you are reporting a bug, please include:</p> | ||
| <ul class="simple"> | ||
| <li><p>Your operating system name and version.</p></li> | ||
| <li><p>Any details about your local setup that might be helpful in troubleshooting.</p></li> | ||
| <li><p>Detailed steps to reproduce the bug.</p></li> | ||
| </ul> | ||
| </section> | ||
| <section id="fix-bugs"> | ||
| <h3>Fix Bugs<a class="headerlink" href="#fix-bugs" title="Link to this heading"></a></h3> | ||
| <p>Look through the GitHub issues for bugs. Anything tagged with “bug” and “help | ||
| wanted” is open to whoever wants to implement it.</p> | ||
| </section> | ||
| <section id="implement-features"> | ||
| <h3>Implement Features<a class="headerlink" href="#implement-features" title="Link to this heading"></a></h3> | ||
| <p>Look through the GitHub issues for features. Anything tagged with “enhancement” | ||
| and “help wanted” is open to whoever wants to implement it.</p> | ||
| </section> | ||
| <section id="write-documentation"> | ||
| <h3>Write Documentation<a class="headerlink" href="#write-documentation" title="Link to this heading"></a></h3> | ||
| <p>Global Logger could always use more documentation, whether as part of the | ||
| official Global Logger docs, in docstrings, or even on the web in blog posts, | ||
| articles, and such.</p> | ||
| </section> | ||
| <section id="submit-feedback"> | ||
| <h3>Submit Feedback<a class="headerlink" href="#submit-feedback" title="Link to this heading"></a></h3> | ||
| <p>The best way to send feedback is to file an issue at <a class="reference external" href="https://github.com/alertua/global_logger/issues">https://github.com/alertua/global_logger/issues</a>.</p> | ||
| <p>If you are proposing a feature:</p> | ||
| <ul class="simple"> | ||
| <li><p>Explain in detail how it would work.</p></li> | ||
| <li><p>Keep the scope as narrow as possible, to make it easier to implement.</p></li> | ||
| <li><p>Remember that this is a volunteer-driven project, and that contributions | ||
| are welcome :)</p></li> | ||
| </ul> | ||
| </section> | ||
| </section> | ||
| <section id="get-started"> | ||
| <h2>Get Started!<a class="headerlink" href="#get-started" title="Link to this heading"></a></h2> | ||
| <p>Ready to contribute? Here’s how to set up <cite>global_logger</cite> for local development.</p> | ||
| <ol class="arabic"> | ||
| <li><p>Fork the <cite>global_logger</cite> repo on GitHub.</p></li> | ||
| <li><p>Clone your fork locally:</p> | ||
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>[email protected]:your_name_here/global_logger.git | ||
| </pre></div> | ||
| </div> | ||
| </li> | ||
| <li><p>Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:</p> | ||
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mkvirtualenv<span class="w"> </span>global_logger | ||
| $<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>global_logger/ | ||
| $<span class="w"> </span>python<span class="w"> </span>setup.py<span class="w"> </span>develop | ||
| </pre></div> | ||
| </div> | ||
| </li> | ||
| <li><p>Create a branch for local development:</p> | ||
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>name-of-your-bugfix-or-feature | ||
| </pre></div> | ||
| </div> | ||
| <p>Now you can make your changes locally.</p> | ||
| </li> | ||
| <li><p>When you’re done making changes, check that your changes pass flake8 and the | ||
| tests, including testing other Python versions with tox:</p> | ||
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>flake8<span class="w"> </span>global_logger<span class="w"> </span>tests | ||
| $<span class="w"> </span>python<span class="w"> </span>setup.py<span class="w"> </span><span class="nb">test</span><span class="w"> </span>or<span class="w"> </span>pytest | ||
| $<span class="w"> </span>tox | ||
| </pre></div> | ||
| </div> | ||
| <p>To get flake8 and tox, just pip install them into your virtualenv.</p> | ||
| </li> | ||
| <li><p>Commit your changes and push your branch to GitHub:</p> | ||
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>add<span class="w"> </span>. | ||
| $<span class="w"> </span>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"Your detailed description of your changes."</span> | ||
| $<span class="w"> </span>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>name-of-your-bugfix-or-feature | ||
| </pre></div> | ||
| </div> | ||
| </li> | ||
| <li><p>Submit a pull request through the GitHub website.</p></li> | ||
| </ol> | ||
| </section> | ||
| <section id="pull-request-guidelines"> | ||
| <h2>Pull Request Guidelines<a class="headerlink" href="#pull-request-guidelines" title="Link to this heading"></a></h2> | ||
| <p>Before you submit a pull request, check that it meets these guidelines:</p> | ||
| <ol class="arabic simple"> | ||
| <li><p>The pull request should include tests.</p></li> | ||
| <li><p>If the pull request adds functionality, the docs should be updated. Put | ||
| your new functionality into a function with a docstring, and add the | ||
| feature to the list in README.rst.</p></li> | ||
| </ol> | ||
| </section> | ||
| <section id="tips"> | ||
| <h2>Tips<a class="headerlink" href="#tips" title="Link to this heading"></a></h2> | ||
| <p>To run a subset of tests:</p> | ||
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>tests.test_global_logger | ||
| </pre></div> | ||
| </div> | ||
| </section> | ||
| <section id="deploying"> | ||
| <h2>Deploying<a class="headerlink" href="#deploying" title="Link to this heading"></a></h2> | ||
| <p>A reminder for the maintainers on how to deploy. | ||
| Make sure all your changes are committed (including an entry in HISTORY.rst). | ||
| Then run:</p> | ||
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>bump2version<span class="w"> </span>patch<span class="w"> </span><span class="c1"># possible: major / minor / patch</span> | ||
| $<span class="w"> </span>git<span class="w"> </span>push | ||
| $<span class="w"> </span>git<span class="w"> </span>push<span class="w"> </span>--tags | ||
| </pre></div> | ||
| </div> | ||
| </section> | ||
| </section> | ||
|
|
||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
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.