Homec4science
Diffusion invenio-infoscience (iugw2017) Browse

R3600/CONTRIBUTING.rst
370ed7e3164aiugw2017

Last Change
Raw File

CONTRIBUTING.rst
View Options

Contribution guide
==================
Interested in contributing to the Invenio project? There are lots of ways to
help.
.. rubric:: Code of conduct
Overall, we're **open, considerate, respectful and good to each other**. We
contribute to this community not because we have to, but because we want to.
If we remember that, our :ref:`code-of-conduct` will come naturally.
.. rubric:: Get in touch
See :ref:`getting-help` and :ref:`communication-channels`. Don't hesitate
to get in touch with the Invenio maintainers (listed in ``MAINTAINERS`` file).
The maintainers can help you kick start your contribution.
Types of contributions
----------------------
Report bugs
~~~~~~~~~~~
- **Found a bug? Want a new feature?** Open a GitHub issue on the applicable
repository and get the conversation started (do search if the issue has
already been reported). Not sure exactly where, how, or what to do?
See :ref:`getting-help`.
- **Found a security issue?** Alert us privately at
`info@inveniosoftware.org <info@inveniosoftware.org>`_, this will allow us to
distribute a security patch before potential attackers look at the issue.
Translate
~~~~~~~~~
- **Missing your favourite language?** Translate Invenio on
`Transifex <https://www.transifex.com/inveniosoftware/invenio/>`_
- **Missing context for a text string?** Add context notes to
translation strings or report the issue as a bug (see above).
- **Need help getting started?** See our :ref:`translation-guide`.
Write documentation
~~~~~~~~~~~~~~~~~~~
- **Found a typo?** You can edit the file and submit a pull request directly on
GitHub.
- **Debugged something for hours?** Spare others time by writing up a short
troubleshooting piece on
https://github.com/inveniosoftware/troubleshooting/.
- **Wished you knew earlier what you know now?** Help write both non-technical
and technical topical guides.
Write code
~~~~~~~~~~
- **Need help getting started?** See our :ref:`developers-guide`.
- **Need help setting up your editor?** See our
:ref:`setting-up-your-environment` guide which helps your automate the
tedious tasks.
- **Want to refactor APIs?** Get in touch with the maintainers and get the
conversation started.
- **Troubles getting green light on Travis?** Be sure to check our
:ref:`style-guide` and the :ref:`setting-up-your-environment`. It will make
your contributor life easier.
- **Bootstrapping a new awesome module?** Use our `Invenio cookiecutter
template <http://github.com/inveniosoftware/cookiecutter-invenio-module>`_.
Style guide (TL;DR)
-------------------
Travis CI is our style police officer who will check your pull
request against most of our :ref:`style-guide`, so do make sure you get a green
light from him.
**ProTip:** Make sure your editor is setup to do checking, linting, static
analysis etc. so you don't have to think. Need help setting up your editor? See
:ref:`setting-up-your-environment`.
Commit messages
~~~~~~~~~~~~~~~
Commit message is first and foremost about the content. You are communicating
with fellow developers, so be clear and brief.
(Inspired by `How to Write a Git Commit Message
<https://chris.beams.io/posts/git-commit/>`_)
1. `Separate subject from body with a blank line
<https://chris.beams.io/posts/git-commit/#separate>`_
2. `Limit the subject line to 50 characters
<https://chris.beams.io/posts/git-commit/#limit-50>`_
3. `Indicate the component follow by a short description <>`_
4. `Do not end the subject line with a period
<https://chris.beams.io/posts/git-commit/#end>`_
5. `Use the imperative mood in the subject line
<https://chris.beams.io/posts/git-commit/#imperative>`_
6. `Wrap the body at 72 characters
<https://chris.beams.io/posts/git-commit/#wrap-72>`_
7. `Use the body to explain what and why vs. how, using bullet points <>`_
**ProTip**: Really! Spend some time to ensure your editor is top tuned. It will
pay off many-fold in the long run. See :ref:`setting-up-your-environment`.
For example::
component: sumarize changes in 50 char or less
* More detailed explanatory text, if necessary. Formatted using
bullet points, preferabely `*`. Wrapped to 72 characters.
* Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.
* The blank line separating the summary from the body is critical
(unless you omit the body entirely); various tools like `log`,
`shortlog` and `rebase` can get confused if you run the two
together.
* Use words like "Adds", "Fixes" or "Breaks" in the listed bullets to help
others understand what you did.
* If your commit closes or addresses an issue, you can metion
it in any of the bullets after the dot. (closses #XXX) (addresses
#YYY)
Co-authored-by: John Doe <john.doe@example.com>
Pull requests
-------------
Need help making your first pull request? Check out the GitHub guide
`Forking Projects <https://guides.github.com/activities/forking/>`_.
When making your pull request, please keep the following in mind:
- Create logically separate commits for logically separate things.
- Include tests and don't decrease test coverage.
- Do write documentation. We all love well-documented frameworks, right?
- Run tests locally using ``run-tests.sh`` script.
- Make sure you have the rights if you include third-party code (and do credit
the orignial creator).
- Green light on all GitHub status checks is required in order to merge your
PR.
.. rubric:: Work in progress (WIP)
Do publish your code as pull request sooner than later. Just prefix the pull
request title with ``WIP`` (=work in progress) if it is not quite ready.
.. rubric:: Allow edits from maintainers
To speed up the integration process, it helps if on GitHub you `allow
maintainers to edit your pull request
<https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/>`_
so they can fix small issues autonomously.
c4science · Help