Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 0 additions & 53 deletions .github/ISSUE_TEMPLATE/bug-report.yml

This file was deleted.

49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 8 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature-request.yml

This file was deleted.

35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -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.
35 changes: 12 additions & 23 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,19 @@
<!---
☝️ PR title should follow conventional commits (https://conventionalcommits.org)
-->
## Summary

### 🔗 Linked issue
<!-- Explain the problem and the solution. -->

### ❓ Type of change
## Related issue

<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
<!-- Link an issue or discussion, or explain why one is not needed. -->

- [ ] 📖 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
<!-- List the commands, tests, or manual checks you ran. -->

<!-- Describe your changes in detail -->
<!-- Why is this change required? What problem does it solve? -->
<!-- If it resolves an open issue, please link to the issue here. For example "Resolves #1337" -->
## Checklist

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] 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.
76 changes: 0 additions & 76 deletions CODE_OF_CONDUCT.md

This file was deleted.

42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 0 additions & 13 deletions SECURITY.md

This file was deleted.

Loading