Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects
Commit 5dff93ff authored by Deepak Khatri's avatar Deepak Khatri :dog:
Browse files

Add project contribution guide

parent e59949a9
Branches
1 merge request!5Add contribution guide
.. _gsoc_contribution_guide:
Contribution
#############
GSoC site uses OpenBeagle CI for builds which means you don't have to setup anything on
your local machine to update anything on the site. To contribute to this site, you can
follow the simple steps provided below.
Fork the project
*****************
Go to `gsoc.beagleboard.io repo on OpenBeagle <https://openbeagle.org/gsoc/gsoc.beagleboard.io>`_
and click on fork button create a fork on your personal OpenBeagle profile.
.. image:: media/fork-button.png
:align: center
After clicking on the fork button, you'll be taken to a page like shown below where you have to,
1. Select your profile from the dropdown.
2. Click on fork project button to initiate the forking process.
.. image:: media/fork-project.png
:align: center
Select file to edit
*******************
After successfully forking the project you have to,
1. Make sure you are on the forked repo on your profile, it should be ``https://openbeagle.org/<user-name>/gsoc.beagleboard.io`` where <user-name> should be replaced with your OpenBeagle username.
2. Select any file you want to edit from the files & folders view of the repo page.
.. image:: media/repo-file-folders.png
:align: center
After selecting the file you have to click on ``edit button`` and then choose either of the options from drop-down,
1. Open in Web IDE, choose this if you want to work on multiple files.
2. Edit single file, choose this if you want to make some small edits in a single file.
.. note:: Choosing Web IDE will load a full VS Code IDE from server which can be bit heavy sometimes.
Start editing
*************
If you select to open your file in web IDE you'll see a familar interface. The IDE is actually a VS code server hosted on OpenBeagle.
.. image:: media/ide.png
:align: center
.. tip:: If you are new to RST you can checkout our `RST cheatsheet <https://docs.beagleboard.org/latest/intro/contribution/rst-cheat-sheet.html>`_
to get yourself familiar with RST.
Now you have to select a file and start editing. Below image shows some,
1. Edits made to the `ideas/index.rst` highlighted with green bar on left side of code editor window near line numbers.
2. Source control button indicating (1) file updated in the repo.
.. image:: media/make-edits.png
:align: center
Just like you do on your normal VS Code IDE, to commit your changes you can either click on Source
control button on press ``CTRL + SHIFT + G`` to see all the edited fils.
.. image:: media/make-edits.png
:align: center
After swithing to source control you have to,
1. Add a commit message in the input feild.
2. Click on ``Commit to main`` button or click on drop down button to choose ``Commit to new branch``.
.. image:: media/commit-changes.png
:align: center
After clicking to commit button you'll be prompted with this window, where you can choose to
commit to main if it's a single edit or commit to a new branch if you want to keep your main branch clean.
.. image:: media/commit-branch.png
:align: center
When all done right, the lower right side of the IDE you'll a prompt showing sucess message.
.. image:: media/commit-success.png
:align: center
If you go back to project, you'll see the commit successfully applied and the
green tick shows that the CI build was aldo successfull .
.. image:: media/commit.png
:align: center
Congratulations, you have made a valuable contribution to an OpenBeagle project!
Create Pull Request
**********************
After making your changes and commiting them to your forked repo, you are set to create a new Pull Request / Merge Request
so that those changes can be merged to upstream repo. To start your new PR click on the dedicated button to create a new
merge request and fill out all the details. The image below shows all the feilds you have to update,
1. Provided a good title that reflects your work.
2. Add a detailed description of the work you have done. Add pictures whenever seems useful.
3. (Optional) you can assign it to yourself if you'll be working on further updates or assign it to someone else who might want to work on the comments we may provide on your work.
4. Add ``lorforlinux`` or ``jkridner`` as reviewer for PRs with site content update or add your mentor as reviewer if it's related to project work / proposal.
5. If you want your commits to be shows as a single commit then you can choose the ``sqash commits ...`` check box.
6. Check if all your commits are shown in the bottom of the screen and if everything looks okay then click on ``Create merge request`` button.
.. image:: media/merge-request.png
:align: center
Now wait for the review and if comments/requests are raised then you can continue working on the project
until everything looks perfect and your changes are merged in upstream.
\ No newline at end of file
contrib/media/commit-branch.png

32.9 KiB

contrib/media/commit-changes.png

174 KiB

contrib/media/commit-success.png

45.9 KiB

contrib/media/commit.png

184 KiB

contrib/media/create-merge-request.png

131 KiB

contrib/media/edit-button.png

180 KiB

contrib/media/fork-button.png

194 KiB

contrib/media/fork-project.png

282 KiB

contrib/media/ide.png

738 KiB

contrib/media/make-edits.png

650 KiB

contrib/media/merge-request.png

185 KiB

contrib/media/repo-file-folders.png

322 KiB

......@@ -108,4 +108,5 @@ Work on awesome OpenSource projects this summer with BeagleBoard.org!
:caption: Project Ideas
ideas/index
contrib/index
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment