diff options
Diffstat (limited to 'doc/developer-notes.md')
| -rw-r--r-- | doc/developer-notes.md | 40 |
1 files changed, 30 insertions, 10 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 7d3d78adfc..7fe292f1f8 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -1,5 +1,5 @@ -Coding -==================== +Developer Notes +=============== Various coding styles have been used during the history of the codebase, and the result is not very consistent. However, we're now trying to converge to @@ -57,7 +57,7 @@ As Doxygen recognizes the comments by the delimiters (`/**` and `*/` in this cas To describe a class use the same construct above the class definition: ```c++ -/** +/** * Alerts are for notifying old versions if they become too obsolete and * need to upgrade. The message is displayed in the status bar. * @see GetWarnings() @@ -172,15 +172,35 @@ Threads - Shutdown : Does an orderly shutdown of everything. -Pull Request Terminology ------------------------- +Ignoring IDE/editor files +-------------------------- + +In closed-source environments in which everyone uses the same IDE it is common +to add temporary files it produces to the project-wide `.gitignore` file. + +However, in open source software such as Bitcoin Core, where everyone uses +their own editors/IDE/tools, it is less common. Only you know what files your +editor produces and this may change from version to version. The canonical way +to do this is thus to create your local gitignore. Add this to `~/.gitconfig`: + +``` +[core] + excludesfile = /home/.../.gitignore_global +``` -Concept ACK - Agree with the idea and overall direction, but have neither reviewed nor tested the code changes. +(alternatively, type the command `git config --global core.excludesfile ~/.gitignore_global` +on a terminal) -utACK (untested ACK) - Reviewed and agree with the code changes but haven't actually tested them. +Then put your favourite tool's temporary filenames in that file, e.g. +``` +# NetBeans +nbproject/ +``` -Tested ACK - Reviewed the code changes and have verified the functionality or bug fix. +Another option is to create a per-repository excludes file `.git/info/exclude`. +These are not committed but apply only to one repository. -ACK - A loose ACK can be confusing. It's best to avoid them unless it's a documentation/comment only change in which case there is nothing to test/verify; therefore the tested/untested distinction is not there. +If a set of tools is used by the build system or scripts the repository (for +example, lcov) it is perfectly acceptable to add its files to `.gitignore` +and commit them. -NACK - Disagree with the code changes/concept. Should be accompanied by an explanation. |