Skip to content

Commit 0f99b6b

Browse files
committed
docs(developing): adapt documentation after infrastructure code split
Adapts documentation for data curators following up the split of the portal's infrastructure code from the content in two repositories. Implements comments from the #3590 pull request review. Upgrades the `cernopendata-portal` image version to 0.2.9. Closes #3678.
1 parent 5560517 commit 0f99b6b

File tree

4 files changed

+461
-107
lines changed

4 files changed

+461
-107
lines changed

CONTRIBUTING.rst

+19-26
Original file line numberDiff line numberDiff line change
@@ -19,33 +19,26 @@ portal developments, you can `watch ongoing discussions
1919
`become part of the team
2020
<https://github.com/orgs/cernopendata/teams>`_.
2121

22-
Code contributions
23-
------------------
22+
Contributions
23+
-------------
2424

2525
We follow typical `GitHub flow
26-
<https://guides.github.com/introduction/flow/index.html>`_.
26+
<https://docs.github.com/en/get-started/using-github/github-flow>`_.
2727

2828
1. Fork this repository into your personal space.
29-
2. Start a new topical branch for any contribution. Name it sensibly,
30-
say ``fix-event-display-icons``.
31-
3. Test your branch on a local site. If everything works as expected,
32-
please `sign your commits
33-
<https://invenio.readthedocs.io/en/latest/technology/git.html#r2-remarks-on-commit-log-messages>`_
34-
to indicate its quality.
35-
4. Create `logically separate commits for logically separate things
36-
<https://invenio.readthedocs.io/en/latest/technology/git.html#r1-remarks-on-commit-history>`_.
37-
Check out our usual `development practices
38-
<https://invenio-github.readthedocs.io/en/latest/contributing.html>`_.
39-
5. Please add any ``(closes #123)`` directives in your commit log
40-
message if your pull request closes an open issue.
41-
6. Issue a pull request. If the branch is not quite ready yet, please
42-
indicate ``WIP`` (=work in progress) in the pull request title.
43-
44-
For more information on how we work with branches, see our `developing
45-
guide <DEVELOPING.rst>`_.
46-
47-
Chatroom
48-
--------
49-
50-
Our chatroom is `on gitter
51-
<https://gitter.im/cernopendata/opendata.cern.ch>`_.
29+
2. Start a new topical branch for any contribution. Name it descriptively, for
30+
example ``fix-cms-2012-collision-energy``.
31+
3. Ideally, test your branch on a local development site to see if everything
32+
works correctly.
33+
4. Open a pull request against this repository. Verify that all the continuous
34+
integration checks are passing. If not, please amend the pull request
35+
accordingly.
36+
37+
For more information on the process, please see our `developing guide
38+
<DEVELOPING.rst>`_.
39+
40+
Support
41+
-------
42+
43+
You can also get in touch via our `Mattermost
44+
<https://mattermost.web.cern.ch/it-dep/channels/opendata>`_ chat room.

0 commit comments

Comments
 (0)