diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml deleted file mode 100644 index 9c39f63..0000000 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ /dev/null @@ -1,53 +0,0 @@ -name: "\U0001F41E Bug Report" -description: Create a report to help us improve Nuxt Content -labels: ['pending triage'] -body: - - type: markdown - attributes: - value: | - Please carefully read the contribution docs before creating a bug report - 👉 https://antelopejs.com/docs/community/how-to-report-bugs - Please use one of the templates below to create a minimal reproduction: - 👉 https://github.com/AntelopeJS/template-blank-typescript for general issues - - type: markdown - attributes: - value: | - Before reporting a bug, please make sure that you have read through our [documentation](https://content.nuxt.com/). - - type: textarea - id: env - attributes: - label: Environment - placeholder: | - - Operating System: `Darwin` - - Node Version: `v18.16.0` - - AntelopeJS Version: `0.0.1` - - Package Manager: `pnpm@8.7.4` - validations: - required: true - - type: textarea - id: reproduction - attributes: - label: Reproduction - description: Please provide a reproduction link. A minimal [reproduction is required](https://antfu.me/posts/why-reproductions-are-required) unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "needs reproduction" label. If no reproduction is provided we might close it. - placeholder: https://github.com/my/reproduction - validations: - required: true - - type: textarea - id: description - attributes: - label: Description - description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. - validations: - required: true - - type: textarea - id: additonal - attributes: - label: Additional context - description: If applicable, add any other context or screenshots here. - - type: textarea - id: logs - attributes: - label: Logs - description: | - Optional if provided reproduction. Please try not to insert an image but copy paste the log text. - render: shell-script diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..5ccafef --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,49 @@ +name: Bug report +description: Report a reproducible problem in an AntelopeJS project +title: "bug: " +body: + - type: markdown + attributes: + value: >- + Do not disclose security vulnerabilities here. Follow the repository's + security policy instead. + - type: input + id: repository + attributes: + label: Package or repository + description: Which AntelopeJS package or repository is affected? + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: Which released version or commit are you using? + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: What happened, and what did you expect instead? + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Minimal reproduction + description: Provide the smallest repository, code sample, or steps that reproduce the problem. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Include relevant Node.js, package-manager, operating-system, and runtime versions. + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add logs, screenshots, or other context. Remove credentials and private data. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f7b743f..9e41a21 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,11 @@ +blank_issues_enabled: false contact_links: - - name: 📚 Documentation + - name: Documentation url: https://antelopejs.com/ - about: Check documentation for usage - - name: 💬 Discussions + about: Read the documentation before opening a usage issue. + - name: Questions and ideas url: https://github.com/AntelopeJS/antelopejs/discussions - about: Use discussions if you have an idea for improvement and asking questions + about: Ask for help or discuss an idea with the community. + - name: Security vulnerability + url: https://github.com/AntelopeJS/.github/blob/main/SECURITY.md + about: Read the private reporting instructions. Do not open a public issue. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml deleted file mode 100644 index 5a0079e..0000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "\U0001F4A1 Feature Request" -about: Suggest an idea or enhancement. -title: '' -labels: 'enhancement' -assignees: '' ---- - -### Is your feature request related to a problem? Please describe - - -### Describe the solution you'd like - - -### Describe alternatives you've considered - - -### Additional context - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..3ee3e3f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,35 @@ +name: Feature request +description: Propose an improvement to an AntelopeJS project +title: "feat: " +body: + - type: input + id: repository + attributes: + label: Package or repository + description: Which AntelopeJS package or repository should change? + validations: + required: true + - type: textarea + id: problem + attributes: + label: Problem + description: What problem or limitation are you trying to solve? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposed solution + description: Describe the desired behavior, including an example when useful. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Which alternatives or workarounds have you considered? + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any relevant links, screenshots, or prior art. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9c0cf68..c36fc14 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,30 +1,19 @@ - +## Summary -### 🔗 Linked issue + -### ❓ Type of change +## Related issue - + -- [ ] 📖 Documentation (updates to the documentation or readme) -- [ ] 🐞 Bug fix (a non-breaking change that fixes an issue) -- [ ] 👌 Enhancement (improving an existing functionality like performance) -- [ ] ✨ New feature (a non-breaking change that adds functionality) -- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change) +## Verification -### 📚 Description + - - - +## Checklist -### 📝 Checklist - - - - - -- [ ] I have linked an issue or discussion. -- [ ] I have updated the documentation accordingly. +- [ ] The pull request title follows Conventional Commits. +- [ ] I added or updated tests when behavior changed. +- [ ] I updated documentation when users or contributors are affected. +- [ ] I documented breaking changes and migration steps. +- [ ] I did not include credentials or unrelated changes. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index cf67af0..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -- The use of sexualized language or imagery and unwelcome sexual attention or - advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic - address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers 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, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at support@antelopejs.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3c9167c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing to AntelopeJS + +Thank you for helping improve AntelopeJS. + +## Before you start + +- Search existing issues and discussions before opening a new one. +- Use an issue to discuss substantial features or behavior changes first. +- Report vulnerabilities privately as described in [SECURITY.md](SECURITY.md). +- Follow our [Code of Conduct](CODE_OF_CONDUCT.md). + +## Development + +Each repository documents its prerequisites and commands in its README. Most +AntelopeJS JavaScript projects use Node.js and pnpm. + +1. Fork or clone the repository. +2. Create a focused branch from the default branch. +3. Install dependencies with the lockfile intact. +4. Make the smallest change that solves the problem. +5. Run the repository's formatting, linting, type-checking, and test commands. +6. Add or update documentation and tests when behavior changes. + +Do not commit generated artifacts, credentials, or unrelated formatting +changes unless the repository explicitly requires them. + +## Commits and pull requests + +Use [Conventional Commits](https://www.conventionalcommits.org/) for commit and +pull request titles, for example `fix(api): handle an empty response`. + +Pull requests should: + +- explain the problem and the chosen solution; +- link the relevant issue or discussion; +- call out breaking changes and migration steps; +- include evidence that the change was tested; +- remain small enough to review safely. + +Maintainers may ask for changes before merging. AntelopeJS repositories +normally squash pull requests, so the pull request title becomes the commit on +the default branch. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index ea43e3f..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,13 +0,0 @@ -# Security Policy - -## Reporting a Vulnerability - -To report a vulnerability, please privately report it via the Security tab on the GitHub repository. If that is impossible, feel free to send an email to **support@antelopejs.com** instead. - -All security vulnerabilities will be promptly verified and addressed. - -While the discovery of new vulnerabilities is rare, we also recommend always using the latest versions of AntelopeJS and other dependencies by maintaining lock files (`yarn.lock`, `package-lock.json` and `pnpm-lock.yaml`) in order to ensure your application remains as secure as possible. - -## Acknowledgments - -We would like to thank all security researchers and community members who have responsibly disclosed vulnerabilities to us.