Skip to content

Commit b7ac6b7

Browse files
Added a structured content to community section of chainsaw website (#1594)
* Added astructured content to community section of chainsaw website Signed-off-by: Manoram Sharma <[email protected]> * remove translations Signed-off-by: Charles-Edouard Brétéché <[email protected]> --------- Signed-off-by: Manoram Sharma <[email protected]> Signed-off-by: Charles-Edouard Brétéché <[email protected]> Co-authored-by: Charles-Edouard Brétéché <[email protected]>
1 parent d1e7cb5 commit b7ac6b7

File tree

6 files changed

+570
-1
lines changed

6 files changed

+570
-1
lines changed

website/docs/community/contribute.md

+150
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# Contributing
2+
3+
Chainsaw, developed by Kyverno, is an advanced end-to-end testing tool for Kubernetes. Our community plays a crucial role in shaping the project by reporting bugs, suggesting features, and improving documentation.
4+
5+
We aim to make our issue tracker, discussion board, and documentation well-structured and easy to navigate. By following our guidelines, you can help us address your requests efficiently.
6+
7+
## How you can contribute
8+
9+
We appreciate your efforts in reporting bugs, requesting features, and engaging in discussions. Here's how you can contribute:
10+
11+
### Creating an issue
12+
13+
<div class="grid cards" markdown>
14+
15+
- :material-bug-outline: &nbsp;
16+
**Something is not working?**
17+
18+
---
19+
20+
Report a bug in Chainsaw by creating an issue with a reproduction
21+
22+
---
23+
24+
[:octicons-arrow-right-24: Report a bug][report a bug]
25+
26+
- :material-file-document-remove-outline: &nbsp;
27+
**Missing information in our docs?**
28+
29+
---
30+
31+
Report missing information or potential inconsistencies in our documentation
32+
33+
---
34+
35+
[:octicons-arrow-right-24: Report a docs issue][report a docs issue]
36+
37+
- :material-lightbulb-on-20: &nbsp;
38+
**Want to submit an idea?**
39+
40+
---
41+
42+
Propose a change, feature request, or suggest an improvement
43+
44+
---
45+
46+
[:octicons-arrow-right-24: Request a change][request a change]
47+
48+
- :material-account-question-outline: &nbsp;
49+
**Have a question or need help?**
50+
51+
---
52+
53+
Ask a question on our [discussion board] and get in touch with our community
54+
55+
---
56+
57+
[:octicons-arrow-right-24: Ask a question][discussion board]
58+
59+
</div>
60+
61+
### Contributing
62+
63+
<div class="grid cards" markdown>
64+
65+
- :material-source-pull: &nbsp;
66+
**Want to create a pull request?**
67+
68+
---
69+
70+
Learn how to create a comprehensive and useful pull request (PR)
71+
72+
---
73+
74+
[:octicons-arrow-right-24: Create a pull request][create a pull request]
75+
76+
</div>
77+
78+
[report a bug]: reporting-a-bug.md
79+
[report a docs issue]: reporting-a-docs-issue.md
80+
[request a change]: requesting-a-change.md
81+
[discussion board]: https://github.com/kyverno/chainsaw/discussions
82+
[add translations]: adding-translations.md
83+
[create a pull request]: making-a-pull-request.md
84+
85+
## Checklist
86+
87+
Before interacting within the project, please consider the following questions to ensure you're using the correct issue template and providing all necessary information.
88+
89+
!!! warning "Issues, discussions, and comments are forever"
90+
91+
Please note that everything you write is permanent and will remain for everyone to read – forever. Therefore, please always be nice and constructive, follow our contribution guidelines, and comply with our [Code of Conduct].
92+
93+
### Before creating an issue
94+
95+
- Are you using the appropriate issue template, or is there another issue template that better fits the context of your request?
96+
- Have you checked if a similar bug report or change request has already been created, or have you stumbled upon something that might be related?
97+
- Did you fill out every field as requested and provide all additional information needed to comprehend your request?
98+
99+
### Before asking a question
100+
101+
- Is the topic a question for our [discussion board], or is it a bug report or change request that should be raised on our [issue tracker]?
102+
- Is there an open discussion on the topic of your request? If the answer is yes, does your question match the direction of the discussion, or should you open a new discussion?
103+
- Did you provide our community with all the necessary information to understand your question and help you quickly, or can you make it easier to help you?
104+
105+
### Before commenting
106+
107+
- Is your comment relevant to the topic of the current page, post, issue, or discussion, or is it better to create a new issue or discussion?
108+
- Does your comment add value to the conversation? Is it constructive and respectful to our community and maintainers? Could you just use a [:octicons-smiley-16: reaction][reaction] instead?
109+
110+
[Code of Conduct]: https://github.com/kyverno/chainsaw/blob/main/CODE_OF_CONDUCT.md
111+
[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
112+
113+
## Rights and responsibilities
114+
115+
As maintainers, we are entrusted with the responsibility to moderate communication within our community, including the authority to close, remove, reject, or edit issues, discussions, comments, commits, and to block users who do not align with our contribution guidelines and our [Code of Conduct]. This role requires us to be actively involved in maintaining the integrity and positive atmosphere of our community. Upholding these standards decisively ensures a respectful and inclusive environment for all members.
116+
117+
### Code of Conduct
118+
119+
Our [Code of Conduct] outlines the expectation for all community members to treat one another with respect, employing inclusive and welcoming language. Our commitment is to foster a positive and supportive environment, free of inappropriate, offensive, or harmful behavior.
120+
121+
We take any violations seriously and will take appropriate action in response to uphold these values.[^1]
122+
123+
[^1]:
124+
**Warning and blocking policy:**
125+
Given the increasing popularity of our project and our commitment to a healthy community, we've defined clear guidelines on how we proceed with violations:
126+
127+
1.1. **First warning:** Users displaying repeated inappropriate, offensive, or harmful behavior will receive a first warning. This warning serves as a formal notice that their behavior is not in alignment with our community standards and Code of Conduct. The first warning is permanent.
128+
129+
1.2. **Second warning and opportunity for resolution:** If the behavior persists, a second warning will be issued. Upon receiving the second warning, the user will be given a 5-day period for reflection, during which they are encouraged to publicly explain or apologize for their actions. This period is designed to offer an opportunity for openly clearing out any misunderstanding.
130+
131+
1.3. **Blocking:** Should there be no response or improvement in behavior following the second warning, we reserve the right to block the user from the community and repository. Blocking is considered a last resort, used only when absolutely necessary to protect the community's integrity and positive atmosphere.
132+
133+
Blocking has been an exceptionally rare necessity in our overwhelmingly positive community, highlighting our preference for constructive dialogue and mutual respect. It aims to protect our community members and team.
134+
135+
### Incomplete issues and duplicates
136+
137+
We have invested significant time and effort in the setup of our contribution process, ensuring that we assess the essential requirements for reviewing and responding to issues effectively. Each field in our issue templates is thoughtfully designed to help us fully understand your concerns and the nature of your matter. We encourage all members to utilize the search function before submitting new issues or starting discussions to help avoid duplicates. Your cooperation is crucial in keeping our community's discussions constructive and organized.
138+
139+
- **Mandatory completion of issue templates:** We need all of the information required in our issue templates because it ensures that every user and maintainer, regardless of their experience, can understand the content and severity of your bug report or change request.
140+
141+
- **Closing incomplete issues:**
142+
We *reserve the right to close issues lacking essential information*, such as but not limited to [minimal reproductions] or those not adhering to the quality standards and requirements specified in our issue templates. Such issues can be reopened once the missing information has been provided.
143+
144+
- **Handling duplicates:** To maintain organized and efficient communication within our [issue tracker] and [discussion board], we *reserve the right to close any duplicated issues or lock duplicated discussions*. Opening multiple channels to ask the same question or report the same issue across different forums hinders our ability to manage and address community concerns effectively. This approach is vital for efficient time management, as duplicated questions can consume the time of multiple team members simultaneously. Ensuring that each issue or discussion is unique and progresses with new information helps us to maintain focus and support our community.
145+
146+
We further *reserve the right to immediately close discussions or issues that are reopened without providing new information* or simply because users have not yet received a response to their issue/question, as the issue is marked as incomplete.
147+
148+
- **Limitations of automated tools:** While we believe in the value and efficiency that automated tools bring to identifying potential issues (such as those identified by Lighthouse, Accessibility tools, and others), simply submitting an issue generated by these tools does not constitute a complete bug report. These tools sometimes produce verbose outputs and may include false positives, which necessitate a critical evaluation. You are of course welcome to attach generated reports to your issue. However, this does not substitute the requirement for a minimal reproduction or a thorough discussion of the findings. *We reserve the right to mark these issues as incomplete and close them.* This practice ensures that we are addressing genuine concerns with precision and clarity, rather than navigating through extensive automated outputs.
149+
150+
<!-- [minimal reproductions]: ../guides/creating-a-reproduction.md -->
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Pull Requests
2+
3+
You can contribute to Chainsaw by making a [pull request] that will be reviewed by maintainers and integrated into the main repository when the changes made are approved. You can contribute bug fixes, documentation changes, or new functionalities.
4+
5+
[pull request]: https://docs.github.com/en/pull-requests
6+
7+
!!! note "Considering a pull request"
8+
9+
Before deciding to spend effort on making changes and creating a pull request, please discuss what you intend to do. If you are responding to what you think might be a bug, please issue a [bug report] first. If you intend to work on documentation, create a [documentation issue]. If you want to work on a new feature, please create a [change request].
10+
11+
Keep in mind the guidance given and let people advise you. It might be that there are easier solutions to the problem you perceive and want to address. It might be that what you want to achieve can already be done by configuration or [customization].
12+
13+
[bug report]: reporting-a-bug.md
14+
[documentation issue]: reporting-a-docs-issue.md
15+
[change request]: requesting-a-change.md
16+
<!-- [customization]: ../customization.md -->
17+
18+
## Learning about pull requests
19+
20+
Pull requests are a concept layered on top of Git by services that provide Git hosting. Before you consider making a pull request, you should familiarize yourself with the documentation on GitHub, the service we are using. The following articles are of particular importance:
21+
22+
1. [Forking a repository]
23+
2. [Creating a pull request from a fork]
24+
3. [Creating a pull request]
25+
26+
Note that they provide tailored documentation for different operating systems and different ways of interacting with GitHub. We do our best in the documentation here to describe the process as it applies to Chainsaw but cannot cover all possible combinations of tools and ways of doing things. It is also important that you understand the concept of a pull-request in general before continuing.
27+
28+
[Forking a repository]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
29+
[Creating a pull request from a fork]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
30+
[Creating a pull request]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
31+
32+
## Pull request process
33+
34+
In the following, we describe the general process for making pull requests. The aim here is to provide the 30k ft overview before describing details later on.
35+
36+
### Preparing changes and draft PR
37+
38+
The diagram below describes what typically happens to repositories in the process or preparing a pull request. We will be discussing the review-revise process below. It is important that you understand the overall process first before you worry about specific commands. This is why we cover this first before providing instructions below.
39+
40+
``` mermaid
41+
sequenceDiagram
42+
autonumber
43+
44+
participant chainsaw
45+
participant PR
46+
participant fork
47+
participant local
48+
49+
chainsaw ->> fork: fork on GitHub
50+
fork ->> local: clone to local
51+
local ->> local: branch
52+
loop prepare
53+
loop push
54+
loop edit
55+
local ->> local: commit
56+
end
57+
local ->> fork: push
58+
end
59+
chainsaw ->> fork: merge in any changes
60+
fork ->>+ PR: create draft PR
61+
PR ->> PR: review your changes
62+
end
63+
```
64+
65+
1. Fork the Repository: Fork the Chainsaw repository on GitHub to create your own copy.
66+
2. Clone to Local: Clone your fork to your local machine.
67+
3. Create a Branch: Create a topic branch for your changes.
68+
4. Set Up Development Environment: Follow the instructions to set up a development environment.
69+
5. Iterate and Commit: Make incremental changes and commit them with meaningful messages.
70+
6. Push Regularly: Push your commits to your fork regularly.
71+
7. Merge Changes from Upstream: Regularly merge changes from the original Chainsaw repository to avoid conflicts.
72+
8. Create a Draft Pull Request: Once satisfied with your changes, create a draft pull request for early feedback.
73+
9. Review and Revise: Review your work critically, address feedback, and refine your changes.
74+
75+
### Finalizing
76+
77+
Once you are happy with your changes, you can move to the next step, finalizing
78+
your pull request and asking for a more formal and detailed review. The diagram
79+
below shows the process:
80+
81+
``` mermaid
82+
sequenceDiagram
83+
autonumber
84+
participant chainsaw
85+
participant PR
86+
participant fork
87+
participant local
88+
89+
activate PR
90+
PR ->> PR: finalize PR
91+
loop review
92+
loop discuss
93+
PR ->> PR: request review
94+
PR ->> PR: discussion
95+
local ->> fork: push further changes
96+
end
97+
PR ->> chainsaw: merge (and squash)
98+
deactivate PR
99+
fork ->> fork: delete branch
100+
chainsaw ->> fork: pull
101+
local ->> local: delete branch
102+
fork ->> local: pull
103+
end
104+
105+
```
106+
107+
1. Finalize PR: Signal that your changes are ready for review.
108+
2. Request Review: Ask the maintainer to review your changes.
109+
3. Discuss and Revise: Engage in discussions, make necessary revisions, and iterate.
110+
4. Merge and Squash: Once approved, the maintainer will merge and possibly squash your commits.
111+
5. Clean Up: Delete the branch used for the PR from both your fork and local clone.

0 commit comments

Comments
 (0)