McSinyx
/
palace
mirror of https://github.com/McSinyx/palace
1
1
Fork 0
Code Issues Releases Activity

Update contribution guidelines

This commit is contained in:
Nguyễn Gia Phong 2020-05-07 22:29:48 +07:00
parent a8e83acdf3
commit 15b4e532e8
16 changed files with 26 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doctrees/contributing.doctree
View File

Binary file not shown.

BIN
doctrees/environment.pickle
View File

Binary file not shown.

2
html/.buildinfo
View File

@ -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: 7b02f7ca4a94725377fc4fed78985519
config: 2d15f2ac65f2553f6de6e37e9bc0b2bb
tags: 645f666f9bcd5a90fca523b33c5a78b7

7
html/_sources/contributing.rst.txt
View File

@ -104,8 +104,8 @@ Via Email
#. Work on your patch with tests and copyright notice included
as described above.
#. Create a patch from the output of ``git diff`` and send it to
one of the maintainers (our emails addresses are available in ``git log``).
#. `git-format-patch`_ and send it to one of the maintainers
(our emails addresses are available under ``git log``).
We will then review and merge it.
In any case, thank you very much for your contributions!
@ -126,6 +126,8 @@ to improve the CI/CD may find it helpful.
In the release note, make sure to include all user-facing changes
since the previous release. This will trigger the CD services
to build the wheels and publish them to PyPI.
#. Wait for the wheel for your platform to arrive to PyPI and install it.
Play around with it for a little to make sure that everything is OK.
#. Under the local repository, checkout the ``gh-pages`` branch.
Often, is it necessary to update the credits under the :doc:`copying`
section and review if the :doc:`reference` section needs any change
@ -195,6 +197,7 @@ except after the final sentence.
.. _push: https://git-scm.com/docs/git-push
.. _create a pull request:
https://help.github.com/articles/creating-a-pull-request
.. _git-format-patch: https://git-scm.com/docs/git-format-patch
.. _twine: https://twine.readthedocs.io/en/latest/
.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
.. _Octave: https://wiki.octave.org/C%2B%2B_style_guide

2
html/_static/documentation_options.js
View File

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.1.5',
VERSION: '0.2.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',

8
html/contributing.html
View File

@ -4,7 +4,7 @@
<html>
<head>
<meta charset="utf-8" />
<title>Getting Involved &#8212; palace 0.1.5 documentation</title>
<title>Getting Involved &#8212; palace 0.2.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -136,8 +136,8 @@ and <code class="docutils literal notranslate"><span class="pre">git</span> <spa
</li>
<li><p>Work on your patch with tests and copyright notice included
as described above.</p></li>
<li><p>Create a patch from the output of <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">diff</span></code> and send it to
one of the maintainers (our emails addresses are available in <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">log</span></code>).
<li><p><a class="reference external" href="https://git-scm.com/docs/git-format-patch">git-format-patch</a> and send it to one of the maintainers
(our emails addresses are available under <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">log</span></code>).
We will then review and merge it.</p></li>
</ol>
<p>In any case, thank you very much for your contributions!</p>
@ -158,6 +158,8 @@ The distribution generated by this command is now referred to as <code class="do
In the release note, make sure to include all user-facing changes
since the previous release. This will trigger the CD services
to build the wheels and publish them to PyPI.</p></li>
<li><p>Wait for the wheel for your platform to arrive to PyPI and install it.
Play around with it for a little to make sure that everything is OK.</p></li>
<li><p>Under the local repository, checkout the <code class="docutils literal notranslate"><span class="pre">gh-pages</span></code> branch.
Often, is it necessary to update the credits under the <a class="reference internal" href="copying.html"><span class="doc">Copying</span></a>
section and review if the <a class="reference internal" href="reference.html"><span class="doc">Reference</span></a> section needs any change

2
html/copying.html
View File

@ -4,7 +4,7 @@
<html>
<head>
<meta charset="utf-8" />
<title>Copying &#8212; palace 0.1.5 documentation</title>
<title>Copying &#8212; palace 0.2.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

2
html/design.html
View File

@ -4,7 +4,7 @@
<html>
<head>
<meta charset="utf-8" />
<title>Design Principles &#8212; palace 0.1.5 documentation</title>
<title>Design Principles &#8212; palace 0.2.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

2
html/genindex.html
View File

@ -5,7 +5,7 @@
<html>
<head>
<meta charset="utf-8" />
<title>Index &#8212; palace 0.1.5 documentation</title>
<title>Index &#8212; palace 0.2.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

2
html/index.html
View File

@ -4,7 +4,7 @@
<html>
<head>
<meta charset="utf-8" />
<title>Welcome to our palace! &#8212; palace 0.1.5 documentation</title>
<title>Welcome to our palace! &#8212; palace 0.2.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

2
html/installation.html
View File

@ -4,7 +4,7 @@
<html>
<head>
<meta charset="utf-8" />
<title>Installation &#8212; palace 0.1.5 documentation</title>
<title>Installation &#8212; palace 0.2.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

2
html/reference.html
View File

@ -4,7 +4,7 @@
<html>
<head>
<meta charset="utf-8" />
<title>Reference &#8212; palace 0.1.5 documentation</title>
<title>Reference &#8212; palace 0.2.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

2
html/search.html
View File

@ -4,7 +4,7 @@
<html>
<head>
<meta charset="utf-8" />
<title>Search &#8212; palace 0.1.5 documentation</title>
<title>Search &#8212; palace 0.2.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

2
html/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
src/conf.py
View File

@ -22,7 +22,7 @@ copyright = '2019, 2020 Nguyễn Gia Phong et al'
author = 'Nguyễn Gia Phong et al.'
# The full version, including alpha/beta/rc tags
release = '0.1.5'
release = '0.2.0'
# -- General configuration ---------------------------------------------------

7
src/contributing.rst
View File

@ -104,8 +104,8 @@ Via Email
#. Work on your patch with tests and copyright notice included
as described above.
#. Create a patch from the output of ``git diff`` and send it to
one of the maintainers (our emails addresses are available in ``git log``).
#. `git-format-patch`_ and send it to one of the maintainers
(our emails addresses are available under ``git log``).
We will then review and merge it.
In any case, thank you very much for your contributions!
@ -126,6 +126,8 @@ to improve the CI/CD may find it helpful.
In the release note, make sure to include all user-facing changes
since the previous release. This will trigger the CD services
to build the wheels and publish them to PyPI.
#. Wait for the wheel for your platform to arrive to PyPI and install it.
Play around with it for a little to make sure that everything is OK.
#. Under the local repository, checkout the ``gh-pages`` branch.
Often, is it necessary to update the credits under the :doc:`copying`
section and review if the :doc:`reference` section needs any change
@ -195,6 +197,7 @@ except after the final sentence.
.. _push: https://git-scm.com/docs/git-push
.. _create a pull request:
https://help.github.com/articles/creating-a-pull-request
.. _git-format-patch: https://git-scm.com/docs/git-format-patch
.. _twine: https://twine.readthedocs.io/en/latest/
.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
.. _Octave: https://wiki.octave.org/C%2B%2B_style_guide