AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-09-19 21:40:22 +00:00
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source 
Update the instructions to match the GitLab workflow.
This commit is contained in:
Emmanuele Bassi 2018-03-13 18:13:46 +00:00
parent b939af0090
commit 27abc9fefe
1 changed files with 34 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
CONTRIBUTING.md
View File

@ -1,7 +1,7 @@
If you want to hack on the GTK+ project, you'll need to have the development If you want to hack on the GTK+ project, you'll need to have the development
tools appropriate for your operating system, including: tools appropriate for your operating system, including:
- Python (2.7 or 3.x) - Python 3.x
- Meson - Meson
- Ninja - Ninja
- Gettext (19.7 or newer) - Gettext (19.7 or newer)
@ -12,19 +12,30 @@ can be found here:
https://developer.gnome.org https://developer.gnome.org
Information about using git with GNOME can be found here: Information about using GitLab with GNOME can be found here:
https://wiki.gnome.org/Git https://wiki.gnome.org/GitLab
In order to get Git GTK+ installed on your system, you need to have the In order to get Git GTK+ installed on your system, you need to have the
required versions of all the GTK+ dependencies; typically, this means a required versions of all the GTK+ dependencies; typically, this means a
recent version of GLib, Cairo, Pango, and ATK. recent version of GLib, Cairo, Pango, and ATK, as well as the platform
specific dependencies for the windowing system you are using (Wayland, X11,
Windows, or macOS).
**Note**: if you plan to push changes to back to the master repository and You should start by forking the GTK repository from the GitLab web UI, and
have a GNOME account, you want to use the following instead: cloning from your fork:
```ssh
$ git clone https://gitlab.gnome.org/yourusername/gtk.git
$ cd gtk
```
**Note**: if you plan to push changes to back to the main repository and
have a GNOME account, you can skip the fork, and use the following instead:
```sh ```sh
$ git clone ssh://<username>@git.gnome.org/git/gtk+ $ git clone git@gitlab.gnome.org:GNOME/gtk.git
$ cd gtk
``` ```
To compile the Git version of GTK+ on your system, you will need to To compile the Git version of GTK+ on your system, you will need to
@ -32,9 +43,21 @@ configure your build using Meson:
```sh ```sh
$ meson _builddir . $ meson _builddir .
$ cd _builddir
$ ninja
``` ```
For information about submitting patches and pushing changes to Git, see the **Note**: For information about submitting patches and pushing changes
`README.md` and `README.commits` files. In particular, don't, under any to Git, see the `README.md` and `README.commits` files. In particular,
circumstances, push anything to Git before reading and understanding don't, under any circumstances, push anything to Git before reading and
`README.commmits`. understanding `README.commmits`.
Typically, you should work on your own branch:
```sh
$ git checkout -b your-branch
```
Once you've finished working on the bug fix or feature, push the branch
to the Git repository and open a new merge request, to let the GTK
maintainers review your contribution.