Skip to content

Commit

Permalink
docs: add documentation for the refinement process in the contribute …
Browse files Browse the repository at this point in the history
…guide (#2779)
  • Loading branch information
YashPimple authored Jan 18, 2024
1 parent 728cea8 commit 4521e89
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,7 @@ ikbr
imagepullsecret
IManager
IMeter
inclusivity
Infof
inlinehilite
inlines
Expand Down Expand Up @@ -512,6 +513,7 @@ previousversion
printargs
printcolumn
privs
Process
proj
promapi
promhttp
Expand Down Expand Up @@ -626,6 +628,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 sessions that are part of the weekly
[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 the project goals.
* 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.

50 changes: 50 additions & 0 deletions docs-new/docs/contribute/general/refinement-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Refinement process

During the Refinement timeblock in community meetings, maintainers engage in technical
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.
- **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 sessions during [community meetings](https://community.cncf.io/keptn-community/) to talk
about their contributions.
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](../index.md)
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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,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 Process: docs/contribute/general/refinement-guide.md
- Software contributions:
- docs/contribute/software/index.md
- Software development environment: docs/contribute/software/dev-environ.md
Expand Down

0 comments on commit 4521e89

Please sign in to comment.