Skip to content

Adds convention reason to conventions, useful for the living documentati... #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 30, 2013
Merged

Adds convention reason to conventions, useful for the living documentati... #46

merged 1 commit into from
Sep 30, 2013

Conversation

JakeGinnivan
Copy link
Member

...on - fixed #37

@JakeGinnivan
Copy link
Member Author

I think the why we have these conventions in place is useful. Especially when developers on teams hit a failing convention test for the first time.

Maybe errors should report the reason too, I only have added to the Html and Markdown reporters

@JakeGinnivan
Copy link
Member Author

Rebased this one so it is able to be merged. This was an idea, I just implemented it while I was working on CT so if @kkozmic you like the idea you can just merge it

@kkozmic
Copy link
Contributor

kkozmic commented Sep 29, 2013

should it be on a IConvention though, or rather passed to the Convention.Is() method?

@JakeGinnivan
Copy link
Member Author

I think it is more static than the title, so i think property is ok.

It also means when you create a custom convention, you get prompted to write the reason before implementing, which is good I think

@kkozmic
Copy link
Contributor

kkozmic commented Sep 30, 2013

So you think that would always be provided by the implementor of the convention, not the user? You think it would suffice to have one for all usages of the convention?

Does every convention require it though? If you have a convention that you put IValueConverters all in a single place... there's no elaborate reasons behind it - you just do it to keep things tidy... not sure if explanation is necessary...

@JakeGinnivan
Copy link
Member Author

Exactly, it would always be provided by the implementor of the convention.

For some yes, the explanation is not groundbreaking, but it is useful for the living documentation. That Wiki scenario where project conventions are.

For example the Dto one is https://github.com/TestStack/ConventionTests/pull/46/files#L8R46

kkozmic added a commit that referenced this pull request Sep 30, 2013
Adds convention reason to conventions, useful for the living documentati...
@kkozmic kkozmic merged commit dfcec58 into TestStack:master Sep 30, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Conventions should have a reason
2 participants