dftimewolf icon indicating copy to clipboard operation
dftimewolf copied to clipboard

Contributor's guide

Open tomchop opened this issue 3 years ago • 2 comments

We want a contributor's guide / help text that is a bit more verbose than what we have now, namely on code idiosyncracies:

  • How to write a good recipe + style
  • How to write a good module (decoupling) + style
  • When to add a new ArtifactContainer class
  • How big do we want PRs to be / how to articulate contributions.

tomchop avatar Dec 08 '21 14:12 tomchop

I'm looking forward to this issue!

If the issue is resolved one day, the link to the contribution guide or code style that exists in the current document is invalid and will need to be updated.

https://github.com/log2timeline/dftimewolf/blob/02aa4cc778fa58baa7adc197947e321807e319e7/docs/developers-guide.md?plain=1#L41

https://github.com/log2timeline/dftimewolf/blob/02aa4cc778fa58baa7adc197947e321807e319e7/docs/developers-guide.md?plain=1#L46

digitalisx avatar Apr 12 '22 16:04 digitalisx

We should revive this now that we have more people contributing. Plus, I am unsure whether ThreadAware modules are included in the current documentation.

tomchop avatar Jun 17 '22 12:06 tomchop