Adding contributing agreement

[kalaspuffar]

Hi @bertfrees, @PaulRambags, and @joeha480

What do you think about these contributing agreement?
Could this be added to all repositories?

Best regards
Daniel

[joeha480]

See: https://github.com/brailleapps/wiki/wiki/Contribution-guidelines

[PaulRambags]

Please merge this Contributing agreement with the one that Joel points to.

[PaulRambags]

The coding style should express the desired behaviour. Instead of listing things you must not do, you should be clear and mention what you should do.
Please rewrite so that this line starts with "Try to stick to:"

[kalaspuffar]

Hi @joeha480, @bertfrees and @PaulRambags.

I've updated this document to incorporate the contribution guide on the wiki. This document might not be required or could just have a link to the wiki, but following the Github guide it's a commonplace where contributors can find information, so having this document could improve reach.

I'm not saying this is the final document, but it's at least more in line with the current project and has the right links.

I am looking forward to your feedback.

Best regards
Daniel

[bertfrees]

Some suggestions:

• Something like: If fixing the issue requires a change in the OBFL specification (maybe refer to https://github.com/brailleapps/wiki/wiki/Software-Architecture), an issue should also be made in the https://github.com/braillespecs/obfl repository, and an agreement should be reached and documentation and schema updated.
• If you don't know how to fix the issue, providing some tests can already be very helpful. (applies to all issues I guess)
• Team might run regression tests and you may be asked to fix possible problems.
• If applicable, use "@" to mention people. (applies to all issues)
• Javadoc isn't mentioned anywhere, also not on the Principles wiki page. But it's quite important that PRs contain Javadocs and/or other comments. Not necessarily when the PR is created, but the team will ask for it anyway, possibly as the last step when all requested changes to the code itself are done.

And yes I agree that having the file in the CONTRIBUTING file in the source code is useful. It would also have been OK to just put a link in it to the wiki (or the other way around). (By the way I also find it useful to have a NEWS/ file in the source code, instead of having that information only on Github. But that's a different topic.)

[bertfrees]

See comment above.