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.

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

Update Contributing docs #4424

Open
wants to merge 24 commits into
base: main
Choose a base branch
from

Conversation

ShohamBit
Copy link
Collaborator

@ShohamBit ShohamBit commented Dec 11, 2024

1. Explain what the PR does

  • enhance documentation of the guidelines
  • add sections on contributing to Tracee source code
  • improve docs on build traces
  • improve docs on the build environment
  • refactor Tracee docs on how to contribute
  • enhance the issues section
  • enhance PR section

0a6f8cc added backport and cherry-pick labels
1ea57fb Merge branch 'main' of https://github.com/aquasecurity/tracee into contributing_docs
f63b97d Merge branch 'contributing_docs' of https://github.com/ShohamBit/tracee into contributing_docs
9f72406 add candidate label docs
6153e85 enhance backported and cherry-picked labels docs
8d70805 Update docs/contributing/overview.md
fe05d9a enhance Issues docs part, added candidate labe docs
5b9a520 Merge branch 'main' of https://github.com/aquasecurity/tracee into contributing_docs
4aae9c7 add help text
c14fbca update make help
540c8ce improve guidelines to use makefiles mostly
ab51f00 improve metrics=1 docs
a6b3995 resolve most changes
0501e58 fix minor issues
363e7b2 add checkers docsto guidelines
c61ecc5 Merge branch 'main' of https://github.com/aquasecurity/tracee into contributing_docs
3b78323 add Kubernetes, Performance and Man docs to tracee

8d70805 Update docs/contributing/overview.md

Co-authored-by: Gregório G. <[email protected]>

2. Explain how to test it

Read the docs and check if they are properly aligned with Tracee's design

3. Other comments

Close #4406

Copy link
Member

@geyslan geyslan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First pass.

docs/contributing/building/building.md Show resolved Hide resolved
docs/contributing/building/building.md Show resolved Hide resolved
docs/contributing/building/environment.md Outdated Show resolved Hide resolved
docs/contributing/guidelines.md Outdated Show resolved Hide resolved
@ShohamBit ShohamBit requested a review from geyslan December 16, 2024 15:13
@ShohamBit ShohamBit requested a review from geyslan December 17, 2024 20:59
@rscampos
Copy link
Collaborator

rscampos commented Dec 20, 2024

First pass

Need to update the result of make help


The difference:

  • need to add: make tracee-operator and make clean-tracee-operator
  • need to remove: make test-signatures

Copy link
Member

@geyslan geyslan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Put some thoughts.

docs/contributing/kubernetes.md Show resolved Hide resolved
docs/contributing/overview.md Outdated Show resolved Hide resolved
Copy link
Member

@geyslan geyslan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM when consider my last suggestions.

@yanivagman @rscampos it would be nice to have other passes from you, as it concerns different areas.

docs/contributing/overview.md Outdated Show resolved Hide resolved
docs/contributing/overview.md Outdated Show resolved Hide resolved
docs/contributing/overview.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs/contributing
3 participants