From ec031836ac5548f511e24005081c8825031680d0 Mon Sep 17 00:00:00 2001 From: iliassjabali Date: Sun, 12 Apr 2026 17:21:30 +0100 Subject: [PATCH] docs: add community standards (CoC, issue templates, PR template) --- .github/ISSUE_TEMPLATE/bug_report.yml | 83 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/docs_improvement.yml | 28 +++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 40 ++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 ++++ CODE_OF_CONDUCT.md | 85 +++++++++++++++++++++ 6 files changed, 257 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs_improvement.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..2963841 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,83 @@ +name: Bug Report +description: Report a bug in AgentSpec +labels: ["bug"] +body: + - type: textarea + id: description + attributes: + label: Description + description: A clear description of the bug. + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: List the steps to reproduce the behavior. + placeholder: | + 1. Run `agentspec validate agent.yaml` + 2. ... + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: What you expected to happen. + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: What actually happened. + validations: + required: true + + - type: input + id: agentspec-version + attributes: + label: AgentSpec version + description: Output of `agentspec --version` + placeholder: "0.1.0" + validations: + required: true + + - type: input + id: node-version + attributes: + label: Node.js version + description: Output of `node --version` + placeholder: "v20.0.0" + validations: + required: true + + - type: input + id: os + attributes: + label: Operating system + description: Your OS and version + placeholder: "macOS 15.0 / Ubuntu 24.04 / Windows 11" + validations: + required: true + + - type: textarea + id: agent-yaml + attributes: + label: Relevant agent.yaml snippet + description: If applicable, paste the relevant portion of your agent.yaml. + render: yaml + validations: + required: false + + - type: textarea + id: logs + attributes: + label: Logs / error output + description: Paste any relevant log output or error messages. + render: shell + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a77278b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Slack + url: https://join.slack.com/t/agent-spec/shared_invite/zt-3v1zn1fck-p_futvhg32iCTI5rwTD_MQ + about: For questions and community chat diff --git a/.github/ISSUE_TEMPLATE/docs_improvement.yml b/.github/ISSUE_TEMPLATE/docs_improvement.yml new file mode 100644 index 0000000..938fd05 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_improvement.yml @@ -0,0 +1,28 @@ +name: Documentation Improvement +description: Suggest improvements to the documentation +labels: ["documentation"] +body: + - type: input + id: page-or-section + attributes: + label: Which page or section + description: The documentation page or section this relates to. + placeholder: "e.g. docs/concepts/operating-modes.md" + validations: + required: true + + - type: textarea + id: what-is-wrong-or-missing + attributes: + label: What is wrong or missing + description: Describe what is incorrect, unclear, or missing. + validations: + required: true + + - type: textarea + id: suggested-improvement + attributes: + label: Suggested improvement + description: How would you improve it? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..2e6c3ef --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,40 @@ +name: Feature Request +description: Suggest a new feature or improvement +labels: ["enhancement"] +body: + - type: textarea + id: problem-or-motivation + attributes: + label: Problem or motivation + description: What problem does this solve? Why is this needed? + validations: + required: true + + - type: textarea + id: proposed-solution + attributes: + label: Proposed solution + description: Describe the solution you'd like. + validations: + required: true + + - type: textarea + id: alternatives-considered + attributes: + label: Alternatives considered + description: Any alternative solutions or features you've considered. + validations: + required: false + + - type: dropdown + id: package + attributes: + label: Package + description: Which package does this relate to? + options: + - "@agentspec/sdk" + - "@agentspec/cli" + - "@agentspec/adapter-langgraph" + - Other + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..688c065 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Summary + + +## Changes + +- + +## Checklist +- [ ] `pnpm test` passes (all packages) +- [ ] `pnpm typecheck` passes (zero errors) +- [ ] `pnpm lint` passes (zero errors) +- [ ] PR description explains **why** the change is needed +- [ ] New features have tests written first (TDD) + +## Related Issues + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9e25c34 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,85 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of unacceptable behavior may be reported to the project maintainers via [GitHub's content reporting tools](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam). For non-urgent community concerns, you may also open an issue at https://github.com/agents-oss/agentspec/issues. + +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations