mirror of
https://github.com/Cian-H/invenio-config-iform.git
synced 2025-12-22 13:11:56 +00:00
119 lines
3.5 KiB
ReStructuredText
119 lines
3.5 KiB
ReStructuredText
Contributing
|
|
============
|
|
|
|
Contributions are welcome, and they are greatly appreciated! Every
|
|
little bit helps, and credit will always be given.
|
|
|
|
Types of Contributions
|
|
----------------------
|
|
|
|
Report Bugs
|
|
~~~~~~~~~~~
|
|
|
|
Report bugs at https://github.com/Cian-H/invenio-config-iform/issues.
|
|
|
|
If you are reporting a bug, please include:
|
|
|
|
* Your operating system name and version.
|
|
* Any details about your local setup that might be helpful in troubleshooting.
|
|
* Detailed steps to reproduce the bug.
|
|
|
|
Fix Bugs
|
|
~~~~~~~~
|
|
|
|
Look through the GitHub issues for bugs. Anything tagged with "bug"
|
|
is open to whoever wants to implement it.
|
|
|
|
Implement Features
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
Look through the GitHub issues for features. Anything tagged with "feature"
|
|
is open to whoever wants to implement it.
|
|
|
|
Write Documentation
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
invenio-config-iform could always use more documentation, whether as part of the
|
|
official invenio-config-iform docs, in docstrings, or even on the web in blog posts,
|
|
articles, and such.
|
|
|
|
Submit Feedback
|
|
~~~~~~~~~~~~~~~
|
|
|
|
The best way to send feedback is to file an issue at
|
|
https://github.com/Cian-H/invenio-config-iform/issues.
|
|
|
|
If you are proposing a feature:
|
|
|
|
* Explain in detail how it would work.
|
|
* Keep the scope as narrow as possible, to make it easier to implement.
|
|
* Remember that this is a volunteer-driven project, and that contributions
|
|
are welcome :)
|
|
|
|
Get Started!
|
|
------------
|
|
|
|
Ready to contribute? Here's how to set up `invenio-config-iform` for local development.
|
|
|
|
1. Fork the `https://github.com/https://github.com/mb-` repo on GitHub.
|
|
2. Clone your fork locally:
|
|
|
|
.. code-block:: console
|
|
|
|
$ git clone git@github.com:your_name_here/invenio-config-iform.git
|
|
|
|
3. Install your local copy into a virtualenv. Assuming you have
|
|
virtualenvwrapper installed, this is how you set up your fork for local
|
|
development:
|
|
|
|
.. code-block:: console
|
|
|
|
$ mkvirtualenv invenio-config-iform
|
|
$ cd invenio-config-iform/
|
|
$ pip install -e .[all]
|
|
|
|
4. Create a branch for local development:
|
|
|
|
.. code-block:: console
|
|
|
|
$ git checkout -b name-of-your-bugfix-or-feature
|
|
|
|
Now you can make your changes locally.
|
|
|
|
5. When you're done making changes, check that your changes pass tests:
|
|
|
|
.. code-block:: console
|
|
|
|
$ ./run-tests.sh
|
|
|
|
The tests will provide you with test coverage and also check PEP8
|
|
(code style), PEP257 (documentation), flake8 as well as build the Sphinx
|
|
documentation and run doctests.
|
|
|
|
6. Commit your changes and push your branch to GitHub:
|
|
|
|
.. code-block:: console
|
|
|
|
$ git add .
|
|
$ git commit -s
|
|
-m "component: title without verbs"
|
|
-m "* NEW Adds your new feature."
|
|
-m "* FIX Fixes an existing issue."
|
|
-m "* BETTER Improves and existing feature."
|
|
-m "* Changes something that should not be visible in release notes."
|
|
$ git push origin name-of-your-bugfix-or-feature
|
|
|
|
7. Submit a pull request through the GitHub website.
|
|
|
|
Pull Request Guidelines
|
|
-----------------------
|
|
|
|
Before you submit a pull request, check that it meets these guidelines:
|
|
|
|
1. The pull request should include tests and must not decrease test coverage.
|
|
2. If the pull request adds functionality, the docs should be updated. Put
|
|
your new functionality into a function with a docstring.
|
|
3. The pull request should work for Python 3.6 and 3.7. Check
|
|
https://github.com/github/Cian-H/invenio-config-iform//actions?query=event%3Apull_request
|
|
and make sure that the tests pass for all supported Python versions.
|