Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(developing): adapt documentation after infrastructure code split #3679

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(developing): adapt documentation after infrastructure code split #3679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5560517
fix(scripts): update fixture checking after repository split
tiborsimko Sep 20, 2024
0f99b6b
docs(developing): adapt documentation after infrastructure code split
tiborsimko Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 19 additions & 26 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,33 +19,26 @@ portal developments, you can `watch ongoing discussions
`become part of the team
<https://github.com/orgs/cernopendata/teams>`_.

Code contributions
------------------
Contributions
-------------

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

1. Fork this repository into your personal space.
2. Start a new topical branch for any contribution. Name it sensibly,
say ``fix-event-display-icons``.
3. Test your branch on a local site. If everything works as expected,
please `sign your commits
<https://invenio.readthedocs.io/en/latest/technology/git.html#r2-remarks-on-commit-log-messages>`_
to indicate its quality.
4. Create `logically separate commits for logically separate things
<https://invenio.readthedocs.io/en/latest/technology/git.html#r1-remarks-on-commit-history>`_.
Check out our usual `development practices
<https://invenio-github.readthedocs.io/en/latest/contributing.html>`_.
5. Please add any ``(closes #123)`` directives in your commit log
message if your pull request closes an open issue.
6. Issue a pull request. If the branch is not quite ready yet, please
indicate ``WIP`` (=work in progress) in the pull request title.

For more information on how we work with branches, see our `developing
guide <DEVELOPING.rst>`_.

Chatroom
--------

Our chatroom is `on gitter
<https://gitter.im/cernopendata/opendata.cern.ch>`_.
2. Start a new topical branch for any contribution. Name it descriptively, for
example ``fix-cms-2012-collision-energy``.
3. Ideally, test your branch on a local development site to see if everything
works correctly.
4. Open a pull request against this repository. Verify that all the continuous
integration checks are passing. If not, please amend the pull request
accordingly.

For more information on the process, please see our `developing guide
<DEVELOPING.rst>`_.

Support
-------

You can also get in touch via our `Mattermost
<https://mattermost.web.cern.ch/it-dep/channels/opendata>`_ chat room.
Loading