-
Notifications
You must be signed in to change notification settings - Fork 83
Contributing
Being an open source project, clcache greatly benefits from many people contributing to the project. Contributions can come in many forms, e.g.
- Code patches
- Code reviews
- Ideas
However, please note that there are many users of clcache with different needs -- some use the Visual Studio IDE, others don't. Some have a CMake-based build system, others use plain batch files. Some build with many concurrent invocations, others don't. Hence, every change to the program should be carefully evaluated.
To help with such evaluations and debugging, it's vital to have good commit logs which not only explain What was changed (this is usually evident from the code change itself, unless the change is too large -- in which case it probably should not have been a single commit in the first place) but also Why. The following pages are very much recommended for some good guidelines on how to write useful commit logs:
- 5 Useful Tips For A Better Commit Message
- A Note About Git Commit Messages
- How To Write A Git Commit Message
In case you'd like to submit a patch which improves performance, please make sure you provide reliably (and verifyable) performance metrics which demonstrate the extend and impact of the change. clcache is all about performance, and it's time consuming and difficult to have a good discussion about performance without having cold hard numbers at hand.