From 7b44f3d8e071667f390a526d4f626ff36b265ca1 Mon Sep 17 00:00:00 2001 From: Romain Vigier Date: Sat, 19 Feb 2022 22:12:19 +0100 Subject: [PATCH] Improve contributing documentation --- CONTRIBUTING.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c0ee3c6..a84eab0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ @@ -27,13 +27,11 @@ You'll need `make` and [NPM](https://www.npmjs.com/) to install the development npm install --save-dev ``` -Create a new branch describing what your're working on, for example `feature/{name-of-the-feature}` or `theme/{name-of-the-theme}`. - When you're done, commit all your changes and create a new merge request. Choose the appropriate merge request template. ### Coding style -We follow the [GNOME Shell coding style](https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/master/HACKING.md) and we use [ESLint](https://eslint.org/) to enforce it. +We follow the [GNOME Shell coding style](https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/HEAD/HACKING.md) and we use [ESLint](https://eslint.org/) to enforce it. To make sure your code follows it: @@ -43,7 +41,7 @@ npm run test-lint ### Copyright notice -If you make changes to a file, please your copyright notice to the top of the file, or in a separate file (named `original-file.ext.license`), following the [SPDX specification](https://spdx.dev/). +If you make changes to a file, please put your copyright notice to the top of the file, or in a separate file (named `original-file.ext.license`), following the [SPDX specification](https://spdx.dev/). Run [`reuse`](https://reuse.software/) to check that all the needed information is present: