Comments (3)
Thank you very much for your feedback.
So far, my projects have worked quite well without any contribution guidelines.
@sharkdp this should likely be your responsibility. It should make the PR process in this repo more stream lined.
What part didn't you like about the PR process? I'm happy for any kind of feedback!
Test guidelines. How many tests should be added and to which files.
As for "how many tests": that's really not something that I can answer in advance. That depends on the complexity of the feature that is to be tested.
As for "which files": There is a single file with unit tests (tests/basic.cpp
) which is most relevant. I have just added a "Development" section to the README that goes into some detail.
Documentation standards. What should be inline comments and what should be added to a wiki.
Again, a difficult question to answer in advance. There is no wiki so far, and I don't think we need one for a small project like this.
* Perhaps an issue / PR template.
So far, I didn't have any trouble with the kind of issues/bug-reports we got. Issue templates often feel too restrictive. I wouldn't really know what to put there right now.
from dbg-macro.
Well it would never hurt to have one.
It's fair I may be thinking too much into this, I just really enjoy this repo and want the best for it.
Obviously not everything can be outlined to a T but some can be given more of a structure. It's mainly the first two points I'm thinking about. A wiki is overkill but some consistency with what all needs comments could be nice. If this continues to become larger and grow in functionality than these things will become more useful, but perhaps the progress will stall soon and this request will be obsolete.
Close this issue if you want. : )
The dev section is a nice addition.
from dbg-macro.
I just really enjoy this repo and want the best for it.
I'm glad you like it - Thank you for your contributions!
It's mainly the first two points I'm thinking about. A wiki is overkill but some consistency with what all needs comments could be nice. If this continues to become larger and grow in functionality than these things will become more useful, but perhaps the progress will stall soon and this request will be obsolete.
It's really hard to put into words. That's the main problem. I think that questions like "how many tests?" do not so much depend on the project, but rather on the feature that a certain PR is implementing. The best answer I could give would be "enough, but not too many" π
I'm going to close this for now, but I'm happy to come back to this, if we feel that there is a need for a guideline in the future.
from dbg-macro.
Related Issues (20)
- Windows Supported? HOT 14
- Broken output of containers HOT 6
- How about output "{?}" string for unknown types instead of failing with static assert? HOT 2
- Allow specifying the output stream HOT 9
- Is support it for android ? HOT 2
- Is it possible to allow variadic template expansion? HOT 8
- VS2015οΌerror C2912 HOT 5
- debug print on some condition HOT 3
- use in Qt HOT 1
- Add output level HOT 2
- `Type does not support the << ostream operator` on custom type HOT 10
- multithread support HOT 1
- Support always on colors HOT 2
- Nested dbg(...) expansion as not expected HOT 2
- How to force print the full content, not the one with ellipsis HOT 3
- Support for container adapters HOT 1
- Fails with Eigen matrices HOT 7
- Suggest /usr/local/include instead of /usr/include HOT 3
- Report a compiling error with old GCC version (GCC 4.8.5) HOT 1
- Some enhancement proposals for CMake based usecases HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from dbg-macro.