Document actions controlled by standard properties

[CharliePoole]

The PropertyAttribute page at https://github.com/nunit/docs/wiki/Property-Attribute says that properties of tests are not used by NUnit. That's not really true. Some standard properties like "Order" are used by NUnit. We should document that usage so users don't accidentally create properties that have an unexpected affect on how the test runs.

[oriash93]

Is this still the case? As I see now, OrderAttribute inherits from NUnitAttribute.

[CharliePoole]

The user can create properties in various ways. A custom property attribute is only one of them.

[oriash93]

@CharliePoole How can I submit changes on wiki pages?

[CharliePoole]

@nunit/framework-team Can somebody else answer how you want people to do this nowadays? I know how I used to authorize people but I don't know the current practice.

[ChrisMaddock]

Hi @oriash93 - I'm afraid we don't really have a nice way to handle this at the moment 😞 Best thing to do is post your suggested changes in a comment or GitHub gist, and one of the team will copy them over. If it's a bigger change, you could also look at cloning the wiki repository itself, to get the original markdown - but unfortunately we don't currently have a set up to submit Pull Requests.

Please don't think that our lack of infrastructure means contributions are any less welcome - it's something we want to get sorted!

[oriash93]

@ChrisMaddock Thanks for the quick reply. I will do so :)

[siprbaum]

Out of curiosity, how do I clone the wiki?
AFAIK collegues at dayjob had some improvements to the documentation, but as it wasn't possible to do it easily by opening a pull request or even attaching a patch they refrained from doing so.

[mikkelbu]

There is a description of how to clone a github wiki in this SO answer, but instead of git clone git@github.com:atuttle/Taffy.wiki.git you will need https://github.com/nunit/docs.wiki.git and perhaps you should call you repository for nunit.docs.wiki, so the command for adding your own remote should be git remote add origin git@github.com:<YOUR_USERNAME>/nunit.docs.wiki.git.

So all in all not a very user-friendly experience, but if you just want to have the wiki locally and e.g. supply a diff then you just need to clone https://github.com/nunit/docs.wiki.git.

[siprbaum]

@mikkelbu Thx, that worked like a charm!

[SeanKilleen]

Hey all,

I know it's been some years, but reviving this conversation here in case someone still wants to submit.

We now have a docfx-based (and github pages hosted) site for our docs. On any doc, you can now click the link to "improve this doc" and submit a pull request.

@oriash93, if you still want to take a crack at this, we'd love to have your contribution!

If not, anyone else can feel free to raise their hand on it. Thanks!

[oriash93]

I'm afraid I don't have the time, but great news nevertheless! Good luck :)