Skip to content

Add Contributing Section to README to explain the use of openspec in this project #92

@ASRagab

Description

@ASRagab

🗣️ Foreword

Thank for taking the time to fill this feature request fully. Without it we may not be able to , and the issue may be closed without resolution.

:person_frowning: Problem Statement

Users wishing to contribute may not be familiar with openspec or how this project intends to use it. It might be worth adding a section that explains the basic workflow as well as any preferences specifically for this project (i.e. when to archive, etc.)

❔ Possible Solution

I think mostly the contributing section should contain a reference to the openspec documentation, and a recommended workflow for the project using openspec native concepts. It should include worfklows, for features vs bug fixes (if there is a desire to treat those differently), as well as how to handle PR comments vis-a-vis the openspec workflow.

⤴️ Describe alternatives you've considered

N/A

➕ Additional context

I think openspec is useful, I think also how to leverage it for context would be worth elucidating.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions