julienyvenat / docker-suricata

Suricata inside a container using Docker

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Community management aspects

fabienleite opened this issue · comments

Hey,

I think (and that's my opinion) a few things are lacking to the project in terms of community management.

I try to make a checklist of what I think a great open source project should always have and you're free to keep whatever you want :

Potentially resolved by PR #1:

  • Add a gitignore
  • Add a Code of Conduct (Convenant is great)

Not resolved by #1:

  • Add a contributing.md. I cannot help you on that, you have to decide by yourself the "technical" rules for your community. That should probably include :
    • The git flow you expect (even if none, it should probably be stated, but I think Github flow is simple and helps organizing)
    • What people can contribute to (no code, code only, documentation only, everything they want, nothing on this repo - if you choose this also include it on README, ...)
    • The rules for contributing if any
    • Other conditions for accepting contributions / PR if any
  • Add a CI to test the build are working when you push updates. You probably want to test multiple environments on this project (multiple Linux, Windows, BSD?, OSX?) so Azure Pipelines and Circle CI are good options, free for open source projects. (That's not project management but quality assurance)

I’ll test this image when I get home, as I’m looking for a Suricata image to deploy on my server. If I think it’s a fit for me, I’ll set you up with a GitLab Runner on my server to test building image changes.