From b511be1ece4288f597e1a7eb386cf8aca0149511 Mon Sep 17 00:00:00 2001 From: Yash Pimple <97302447+YashPimple@users.noreply.github.com> Date: Thu, 18 Jan 2024 12:47:11 +0530 Subject: [PATCH] docs: add documentation for the refinement process in the contribute guide (#2779) Signed-off-by: vickysomtee --- .github/actions/spelling/expect.txt | 3 ++ .../general/contrib-guidelines-gen.md | 14 ++++++ .../contribute/general/refinement-guide.md | 50 +++++++++++++++++++ mkdocs.yml | 1 + 4 files changed, 68 insertions(+) create mode 100644 docs-new/docs/contribute/general/refinement-guide.md diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index a0e3095ffae..fb2b03f4f15 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -259,6 +259,7 @@ ikbr imagepullsecret IManager IMeter +inclusivity Infof inlinehilite inlines @@ -512,6 +513,7 @@ previousversion printargs printcolumn privs +Process proj promapi promhttp @@ -626,6 +628,7 @@ teststep tgz thisthatdc thschue +timeblock timeframe Timerange timeseries diff --git a/docs-new/docs/contribute/general/contrib-guidelines-gen.md b/docs-new/docs/contribute/general/contrib-guidelines-gen.md index 572d436361a..15e64650657 100644 --- a/docs-new/docs/contribute/general/contrib-guidelines-gen.md +++ b/docs-new/docs/contribute/general/contrib-guidelines-gen.md @@ -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. + \ No newline at end of file diff --git a/docs-new/docs/contribute/general/refinement-guide.md b/docs-new/docs/contribute/general/refinement-guide.md new file mode 100644 index 00000000000..3454077de12 --- /dev/null +++ b/docs-new/docs/contribute/general/refinement-guide.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index 5872a144756..d643e17795a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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