Skip to content
Snippets Groups Projects

Add quick-start-contribution-onboarding.rst and improve gitlab.rst

Merged Grzegorz Gwóźdź requested to merge gwozdzcfs/docs:ADD-HOW-TO-CONTRIBUTE into main
1 file
+ 23
14
Compare changes
  • Side-by-side
  • Inline
@@ -34,7 +34,13 @@ When you complete that, follow the instructions sent to your email to activate t
Signing the ECA
---------------
In order to contribute to the |main_project_name| you need to sign the `ECA <https://accounts.eclipse.org/user/eca>`_.
In order to contribute to the |main_project_name| you need to sign the
`Eclipse Contributor Agreement <https://accounts.eclipse.org/user/eca>`_,
which describes terms under which you can contribute to the project.
This ECA, and the license(s) associated with the particular Eclipse projects you are contributing to, provides a license to your
Contributions to Eclipse and downstream consumers, but you still own your Contributions, and except for the licenses provided
for in this ECA, you reserve all right, title and interest in your Contributions.
Setting up Gitlab
-----------------
@@ -57,18 +63,12 @@ If you complete previous steps, your account is ready and you can contribute to
Setting up git
--------------
Make sure to have git installed in your device. After that configure it by
typing:
.. code-block:: bash
$ git config user.email "your_eclipse_account_email"
$ git config user.name "Your eclipse full name"
Make sure you have git installed in your device.
Forking the repository
----------------------
First fork your project by going to the `the Oniro Gitlab <https://gitlab.eclipse.org/eclipse/oniro-core/oniro>`_
First fork your project by going to `the Oniro Gitlab <https://gitlab.eclipse.org/eclipse/oniro-core/oniro>`_
and clicking on the fork button that is in the top right of the screen.
Working on your repository
@@ -76,7 +76,14 @@ Working on your repository
1. Clone your fork by typing ``git clone`` and adding address of your fork which can be found by
clicking ``Clone`` button in your fork's website. You can clone it by SSH or HTTPS.
#. Start working on the project by creating a new branch.
#. Enter the directory with your local repository and configure it by typing:
.. code-block:: bash
$ git config --local user.email <your_eclipse_account_email>
$ git config --local user.name <your_eclipse_full_name>
3. Start working on the project by creating a new branch.
#. Make your changes, then add and commit
them. Each commit has to be signed off by the e-mail used in your Eclipse account
(add ``-s`` to every ``git commit``). Give relevant names to your commits, to point
@@ -91,10 +98,12 @@ Creating the Merge Request
#. Create a Merge Request by clicking ``Merge Requests`` on left toolbar
and press ``New merge request``. Add an explainable description and create a merge request.
Alternatively, you can enter the website of your fork. You should see a message that you
pushed your branch to the repository. In the same section you can press ``Create merge request``.
#. Before merging, it has to be reviewed and approved by 2 of |main_project_name| repository
maintainers. Read their review and add any required changes to your merge request.
#. After you polish your merge request the maintainers will run the pipelines which will check
if your changes don't break the project and approve to merge it to the main project.
Remember that changes which were added on top of changes introduced in the MR, should be squashed into the initial
commit.
if your changes don't break the project and approve them. If everything is correct, your work
is merged to the main project. Remember that changes which were added on top of
changes introduced in the MR, should be squashed into the initial commit.
Loading