doc: Add developer notes about gitignore #6878

pull laanwj wants to merge 1 commits into bitcoin:master from laanwj:2015_10_ignore_files changing 2 files +33 −3

laanwj commented at 10:34 AM on October 23, 2015: member
- Add developer notes about .gitignore.
- Remove qt creator specific files from gitignore, to be consistent
Context: discussion in #6813, this is a bit of a FAQ so worth mentioning.
laanwj added the label Docs and Output on Oct 23, 2015
btcdrak commented at 11:12 AM on October 23, 2015: contributor

Good.

You should mention the simple command line however which does most of the hard work as per https://help.github.com/articles/ignoring-files/#create-a-global-gitignore
dexX7 commented at 11:44 AM on October 23, 2015: contributor

Thanks for the information, very helpful!
fanquake commented at 11:52 AM on October 23, 2015: member

ACK
jonasschnelli commented at 11:59 AM on October 23, 2015: contributor

ACK.

doc: Add developer notes about gitignore

- Add developer notes about `.gitignore.`
- Remove qt creator specific files from gitignore, to be consistent.

dca7bd3152

laanwj force-pushed on Oct 23, 2015
laanwj commented at 12:46 PM on October 23, 2015: member

You should mention the simple command line however which does most of the hard work as per https://help.github.com/articles/ignoring-files/#create-a-global-gitignore

Added a mention of that - personally I prefer editing the config file manually, instead of memorizing the command, don't think it's very hard work :)
in doc/developer-notes.md:None in dca7bd3152
```
 170 | @@ -171,3 +171,36 @@ Threads
 171 |  - BitcoinMiner : Generates bitcoins (if wallet is enabled).
 172 |  
 173 |  - Shutdown : Does an orderly shutdown of everything.
 174 | +
 175 | +Ignoring IDE/editor files
 176 | +--------------------------
 177 | +
 178 | +In closed-source environments in which everyone uses the same IDE it is common
 179 | +to add temporary files it produces to the project-wide `.gitignore` file.
```
luke-jr commented at 1:37 PM on October 23, 2015:

Also fairly standard practice in open-source environments... (Not saying we have to do it, but this description isn't correct.)

laanwj commented at 2:00 PM on October 23, 2015:

In my experience in - much more heterogeneous, multiplatform - open source projects it's rare to see ignores for specific tools that some of the developers use

btcdrak commented at 2:51 PM on October 23, 2015:

I think the point is that ignore files should always be specific to the project, and not to the developer's environment. So IDE files for example should always be in the user's own gitignore and not the project source's.

luke-jr commented at 2:55 PM on October 23, 2015:

I'm thinking things like *~
petertodd commented at 5:32 PM on October 23, 2015: contributor

ACK
MarcoFalke commented at 2:53 PM on October 24, 2015: member

ACK .gitignore diff

Meh, "doesn't hurt" on the dev notes.
laanwj merged this on Oct 26, 2015
laanwj closed this on Oct 26, 2015
laanwj referenced this in commit 867d6c90b8 on Oct 26, 2015
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#6813 Support gathering code coverage data for RPC tests with lcov