-
Notifications
You must be signed in to change notification settings - Fork 715
Description
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:
- issue opened
- get the necessary consensus for the proposed update in the opened issue
- 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 likefeat,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-guidelinesfix/42/memory-leak-agent-cleanup