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

docs: add documentation for the refinement process in the contribute guide #2779

Merged
merged 4 commits into from
Jan 18, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,7 @@ ikbr
imagepullsecret
IManager
IMeter
inclusivity
Infof
inlines
Intelli
Expand Down Expand Up @@ -620,6 +621,7 @@ teststep
tgz
thisthatdc
thschue
timeblock
timeframe
Timerange
timeseries
Expand Down
14 changes: 14 additions & 0 deletions docs-new/docs/contribute/general/contrib-guidelines-gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,17 @@ please create an issue on the GitHub repository.
* If you want to do the work on an issue,
include that information in your description of the issue
or in a comment to the issue.

## Proposing new work

* Create and refine a ticket
* When proposing new work, start by creating an issue or ticket in the project's
[issue tracker](https://github.com/keptn/lifecycle-toolkit/issues).
* Actively participate in the refinement meetings sessions that are part of the weekly
YashPimple marked this conversation as resolved.
Show resolved Hide resolved
[community meetings](https://community.cncf.io/keptn-community/).
* In these sessions, everyone discusses the proposed work, whether it is a good idea,
what exactly should be done and how it aligns with project goals.
YashPimple marked this conversation as resolved.
Show resolved Hide resolved
* After the discussions, maintainers engage in a process known as **Scrum Poker**.
This involves a voting mechanism where maintainers collectively assess the size
and complexity of the proposed work, helping to decide whether it should proceed.
YashPimple marked this conversation as resolved.
Show resolved Hide resolved

49 changes: 49 additions & 0 deletions docs-new/docs/contribute/general/refinement-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Refinement timeblock
YashPimple marked this conversation as resolved.
Show resolved Hide resolved

During Refinement timeblock, maintainers engage in technical
YashPimple marked this conversation as resolved.
Show resolved Hide resolved
discussions on open issues and pull requests.
This dedicated time allows for in-depth conversations, knowledge sharing,
and collective decision-making.
It is an opportunity for the team to synchronize their understanding of
ongoing developments, address challenges, and ensure a common vision for the project.

**Purpose and goals:**

- **Alignment:** Ensure a shared understanding among maintainers regarding ongoing
developments, project goals, and upcoming tickets.
- **Technical Depth:** Delve into the technical aspects of open issues and pull
requests, facilitating a deeper understanding of proposed Pull requests.
YashPimple marked this conversation as resolved.
Show resolved Hide resolved
- **Decision-Making:** Make collective decisions on the adoption of new features,
changes, and improvements based on technical merit.

This process aligns with our commitment to open-source principles, ensuring that
technical discussions are inclusive, transparent, and beneficial for the
entire Keptn community.

## Contributor guidance

Contributors proposing new features are encouraged to participate in
[refinement meetings](https://community.cncf.io/keptn-community/) related
to their contributions.
YashPimple marked this conversation as resolved.
Show resolved Hide resolved
This provides valuable insights into ongoing technical discussions and
aligns their efforts with the broader project vision.
Follow these steps:

1. Review the project's [contributing guide](../docs/contrib-guidelines-docs.md)
YashPimple marked this conversation as resolved.
Show resolved Hide resolved
YashPimple marked this conversation as resolved.
Show resolved Hide resolved
for information on upcoming refinement meetings.
1. Attend relevant refinement meetings to present and discuss proposed features.
1. Actively engage in technical discussions, seeking feedback and guidance from
maintainers.
1. Iteratively refine contributions based on insights gained during meetings.

By following this process, contributors contribute not only code but also valuable
perspectives and insights, fostering a collaborative and innovative
community environment.

## Outcome

- Shared understanding among maintainers and contributors on ongoing developments.
- Improved contributions via collaborative discussions and refinement.
- Documented decisions and action items for future reference in project documentation.
This refined process aligns with our commitment to open-source principles, ensuring
transparency, inclusivity, and technical excellence within the Keptn community.
YashPimple marked this conversation as resolved.
Show resolved Hide resolved
YashPimple marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ nav:
- Create PR: docs/contribute/general/git/pr-create.md
- PR review process: docs/contribute/general/git/review.md
- Contribution Guidelines: docs/contribute/general/contrib-guidelines-gen.md
- Refinement Timeblock: docs/contribute/general/refinement-guide.md
YashPimple marked this conversation as resolved.
Show resolved Hide resolved
- Software contributions:
- docs/contribute/software/index.md
- Software development environment: docs/contribute/software/dev-environ.md
Expand Down
Loading