F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Update enhancements.rst

Browse Source
This commit is contained in:
Tom Henderson
2022-10-06 15:56:05 +01:00
committed by Eduardo Almeida
parent 7279f9c135
commit c72bdf2c37
1 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/contributing/source/enhancements.rst
View File

@@ -211,13 +211,22 @@ Here is an example making use of both:
6. Use the present tense ("Add feature", not "Added feature") and the imperative mood ("Move cursor to ...", not "Moves cursor to...").
No extraneous white space
=========================
Code formatting
===============
Do not make whitespace changes to unrelated parts of the code (unrelated
to your merge request). This can often happen if the `check-style.py`
program is used on existing files. Use the automated style correction
program `check-style.py` only on your *new* source code files.
|ns3| uses a utility called ``clang-format`` to check and fix formatting
issues with code. Please see the chapter on coding
style to learn more about how to use this tool. When submitting
code to the project, it is a good idea to check the formatting on your
new files and modifications before submission.
Avoid unrelated changes
=======================
Do not make changes to unrelated parts of the code (unrelated
to your merge request). If in the course of your work on a given
topic, you discover improvements to other things (like documentation
improvements), please open a separate merge request for separate topics.
Squashing your history
======================