[go: nahoru, domu]
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation of coding standard #333

Open
iyehuda opened this issue Apr 7, 2020 · 1 comment
Open

Add documentation of coding standard #333

iyehuda opened this issue Apr 7, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@iyehuda
Copy link
Contributor
iyehuda commented Apr 7, 2020

What would you like to be added

We should extend the contribution guide (CONTRIBUTING.md) with documentation about coding standards in this project.
We can alternatively create a HACKING.md file and put it there.

The documentation should include information about:

  • Linting:
    • imports
    • literals
    • linting tools used in this project (CI/precommit hook)
  • Testing:
    • Unit test standards
    • Integration tests (we should start making those)
  • Architecture:
    • Data pipeline (event system)
    • Code location
    • Principles to add new code

Why is this needed

  • Make code reviews shorter and save commenting about such topics
  • Welcome new developers
  • Preserve and share knowledge
@iyehuda iyehuda added the enhancement New feature or request label Apr 7, 2020
@avats-dev
Copy link

@iyehuda I can work on this. Should I start? Also, I might need some help along the way. Thanks.

py-go pushed a commit to py-go/kube-hunter that referenced this issue Aug 29, 2021
@danielpacak @simar7
refactor: Define interface for resource configuration checkers (aquas…
0882c9e 
…ecurity#333)

Signed-off-by: Daniel Pacak <pacak.daniel@gmail.com>
Co-authored-by: Simarpreet Singh <simar@linux.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@iyehuda @avats-dev