diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 7e243586b7..1f87349531 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -258,6 +258,7 @@ ikbr imagepullsecret IManager IMeter +inclusivity Infof inlines Intelli diff --git a/docs-new/docs/contribute/general/contrib-guidelines-gen.md b/docs-new/docs/contribute/general/contrib-guidelines-gen.md index 572d436361..496f3a44ec 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/issue). + * Actively participate in the refinement meetings 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 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 0000000000..bdf44b74ac --- /dev/null +++ b/docs-new/docs/contribute/general/refinement-guide.md @@ -0,0 +1,49 @@ +# Refinement timeblock + +During Refinement timeblock, 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 meetings](https://community.cncf.io/keptn-community/) related +to 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](../docs/contrib-guidelines-docs.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.