camunda/camunda-bpm-assert

Improve Guidelines for Contributing

malteser opened this issue · 7 comments

As a new contributor, I need to know all design decisions + reasoning, in order to provide good contribututions.

I more than agree! Sorry that some of your effort so far was probably frustrated because of the lack of such guidelines. I guess we should complete this issue after having released a 2.0 with CMMN assertions, because we will then be fully aware of the guidelines and patterns we actually see.

I would like to add some stuff to the md and create a new ticket for refining it after the 2.0 release.
Stuff would be

  1. create a ticket
  2. small piece of work
  3. make fork + branch
  4. implement, document in md, document in javadoc, test systematically
  5. create pull request

addition for CMMN:

  1. before making pul lrequest, mark implemented feature in cmmn.md

Sure! When improving the CONTRIBUTING.md you could also delete the placeholder stuff there. The file was actually never properly edited so far...

Hm, can't assign this issue to me. 😞

I fear I can't change that quickly, because I am not an owner of that repository either. I will look into that with Camunda staff and come back to you.

Maybe it's ok that way. In the end, assigning is meant for keeping track on who's working on what. We could as well make a "mine!" comment in an issue.

Done. See #61