Skip to content

CODE_OF_CONDUCT and CONTRIBUTING docs #388

@egesabanci

Description

@egesabanci

would like to suggest adding two important community files to this project:

CODE_OF_CONDUCT.md: helps establish clear expectations for behavior and promotes a respectful and inclusive environment for all contributors and users.

CONTRIBUTING.md: provides guidance on how to contribute effectively, including steps for submitting pull requests, coding conventions, and how to report issues or suggest features.

these files are helpful for both new and experienced contributors, and are often considered standard in open source projects, they also improve project visibility on Github by signaling that the project is welcoming to contributions

also suggest something like this for the resolve flow of each issue:

  1. issue opened
  2. get the necessary consensus for the proposed update in the opened issue
  3. create PR with a special naming format (see below) for update, never master (dev local) -> master (remote) pull-request merge

PR naming format: <type>/<issue-id>/<short-description>

Where:

  • <type>: Use conventional commit types like feat, fix, chore, docs, test, refactor, BREAKING_CHANGE
  • <issue-id>: The GitHub issue number you're working on
  • <short-description>: Brief description with words separated by hyphens

Examples:

  • feat/388/add-contributing-guidelines
  • fix/42/memory-leak-agent-cleanup

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions