gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-11-25 12:32:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove signoff step from contributing guide.

Browse Source
This commit is contained in:
yenatch
2018-07-02 16:04:53 -04:00
parent 5e9c433a24
commit 361015497c
1 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.rst
View File

@@ -75,24 +75,22 @@ copyright and the reference to the MIT License.
new warning (but it may be possible to remove some warning checks if it makes new warning (but it may be possible to remove some warning checks if it makes
the code much easier). the code much easier).
5. Sign off your commits: ``git commit -s`` 5. Follow the Linux kernel coding style, which can be found in the file
6. Follow the Linux kernel coding style, which can be found in the file
``Documentation/process/coding-style.rst`` in the Linux kernel repository. ``Documentation/process/coding-style.rst`` in the Linux kernel repository.
Note that the coding style isn't writen on stone, if there is a good reason Note that the coding style isn't writen on stone, if there is a good reason
to deviate from it, it should be fine. to deviate from it, it should be fine.
7. Download the files ``checkpatch.pl``, ``const_structs.checkpatch`` and 6. Download the files ``checkpatch.pl``, ``const_structs.checkpatch`` and
``spelling.txt`` from the folder ``scripts`` in the Linux kernel repository. ``spelling.txt`` from the folder ``scripts`` in the Linux kernel repository.
8. To use ``checkpatch.pl`` you can use ``make checkpatch``, which will check 7. To use ``checkpatch.pl`` you can use ``make checkpatch``, which will check
the coding style of all patches between the current one and the upstream the coding style of all patches between the current one and the upstream
code. By default, the Makefile expects the script (and associate files) to be code. By default, the Makefile expects the script (and associate files) to be
located in ``../linux/scripts/``, but you can place them anywhere you like as located in ``../linux/scripts/``, but you can place them anywhere you like as
long as you specify it when executing the command: long as you specify it when executing the command:
``CHECKPATCH=../path/to/folder make checkpatch``. ``CHECKPATCH=../path/to/folder make checkpatch``.
9. Create a pull request against the branch ``develop``. 8. Create a pull request against the branch ``develop``.
10. Be prepared to get some comments about your code and to modify it. Tip: Use 9. Be prepared to get some comments about your code and to modify it. Tip: Use
``git rebase -i origin/develop`` to modify chains of commits. ``git rebase -i origin/develop`` to modify chains of commits.