Skip to content

Sync and Update Contributing guidelines #981

@frewilhelm

Description

@frewilhelm

Description

A quick research showed that the contributing guidelines are "a bit" outdated by now.

For example the Release process in the .github/CONTRIBUTING.md tells the user to update a variable in pkg/version/release.go. This directory structure does not exist anymore and the release process for the ocm repository was completely restructured.

The Contributing guide in open-component-model looks okayish but has a table with variables at the end of the document that looks.. interesting.

Done Criteria

  • Check out every contributing guide in the org for relevant repositories
  • Update the general contributing guide in .github with guidelines that apply to all our repositories like issues and PR format (appropriate title for release notes), how to fork and clone, AI usage, DCO, licensing, ...
    • We will use a central contributing guide on the website that covers the general stuff for all contributions and have repository and topic specific contributing guides
  • Update all other repository-scoped/specific contributing guides in every relevant repository
    • Every repository-scoped contributing guide should first refer to the general one and then describe repository specific contributing guidelines (if any)
  • Guides has been reviewed by other team members
  • Successful demonstration in Review

Metadata

Metadata

Assignees

Labels

area/ipceiImportant Project of Common European Interestkind/tasksmall task, normally part of feature or epic

Type

No fields configured for Task.

Projects

Status
🍺 Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions