Skip to content

Commit

Permalink
fix: failed checks
Browse files Browse the repository at this point in the history
Signed-off-by: Yash Pimple <[email protected]>
  • Loading branch information
YashPimple committed Jan 10, 2024
1 parent b7a1d29 commit ef1d86b
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 0 deletions.
9 changes: 9 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,12 @@ 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.
* Actively participate in [refinement meetings](https://community.cncf.io/keptn-community/)
to discuss and refine your proposed features.
* Follow the Refinement Timeblock process for collaborative discussions and feedback.

Check failure on line 53 in docs-new/docs/contribute/general/contrib-guidelines-gen.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`Timeblock` is not a recognized word. (unrecognized-spelling)

Check failure on line 53 in docs-new/docs/contribute/general/contrib-guidelines-gen.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`Timeblock` is not a recognized word. (unrecognized-spelling)
* Iteratively refine your contributions based on insights gained during these meetings.
52 changes: 52 additions & 0 deletions docs-new/docs/contribute/general/refinement-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Refinement Timeblock

Check failure on line 1 in docs-new/docs/contribute/general/refinement-guide.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`Timeblock` is not a recognized word. (unrecognized-spelling)

Check failure on line 1 in docs-new/docs/contribute/general/refinement-guide.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`Timeblock` is not a recognized word. (unrecognized-spelling)

During the Refinement Timeblock, maintainers engage in focused technical

Check failure on line 3 in docs-new/docs/contribute/general/refinement-guide.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`Timeblock` is not a recognized word. (unrecognized-spelling)

Check failure on line 3 in docs-new/docs/contribute/general/refinement-guide.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`Timeblock` is not a recognized word. (unrecognized-spelling)
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.
- **Feedback Loop:** Establish an effective feedback loop where maintainers can
provide insights and guidance on contributions.
- **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.
2. Attend relevant refinement meetings to present and discuss proposed features.
3. Actively engage in technical discussions, seeking feedback and guidance from
maintainers.
4. 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

- A shared understanding among maintainers and contributors regarding the technical
landscape of ongoing developments.
- Improved contributions through collaborative discussions and iterative 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.

Check failure on line 52 in docs-new/docs/contribute/general/refinement-guide.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`inclusivity` is not a recognized word. (unrecognized-spelling)

Check failure on line 52 in docs-new/docs/contribute/general/refinement-guide.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`inclusivity` is not a recognized word. (unrecognized-spelling)

0 comments on commit ef1d86b

Please sign in to comment.