Skip to content
Closed
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
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: "🐛 Bug Report"
description: "Report a bug in the application"
labels: [bug]
body:
- type: markdown
attributes:
value: |
## Describe the Bug
- type: textarea
id: bug-description
attributes:
label: "What happened?"
description: "Describe what the bug is, and how to reproduce it."
placeholder: "Steps to reproduce the bug..."
- type: textarea
id: steps-to-reproduce
attributes:
label: "Steps to Reproduce"
description: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
placeholder: "List the steps to reproduce the bug..."
- type: input
id: environment
attributes:
label: "Environment (OS, Node.js, pnpm, Project version)"
description: "Provide details about your environment to help with debugging."
placeholder: "e.g. Ubuntu 20.04, Node.js 16.13.0, pnpm 6.14.5, v1.2.3"
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: 📬 Contact the Team
url: https://github.com/ansopedia/notification-service/discussions
about: Ask questions, suggest ideas, or start a discussion
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: "✨ Feature Request"
description: "Suggest a new feature or enhancement"
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
## Feature Summary
- type: textarea
id: feature-summary
attributes:
label: "Summary"
description: "Provide a short summary of the feature or enhancement."
placeholder: "Briefly describe the feature..."
- type: textarea
id: motivation
attributes:
label: "Motivation"
description: "Explain why this feature is needed and the problem it solves."
placeholder: "Why is this feature important?"
- type: textarea
id: proposed-solution
attributes:
label: "Proposed Solution"
description: "Describe the solution or approach you suggest."
placeholder: "How would you implement this feature?"
- type: textarea
id: alternatives
attributes:
label: "Alternatives Considered"
description: "List any alternative solutions or features you considered."
placeholder: "Other options you considered..."
- type: input
id: environment
attributes:
label: "Environment (OS, Node.js, pnpm, Project version)"
description: "Provide details about your environment to help with debugging."
placeholder: "e.g. Ubuntu 20.04, Node.js 16.13.0, pnpm 6.14.5, v1.2.3"
14 changes: 0 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bugfix_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
What was the bug? How was it fixed?

## 🔗 Related Issues

Link any issues this PR fixes.

## ✅ Checklist

- [ ] Bug is fixed
- [ ] Regressions tested
- [ ] Lint and tests pass
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/feature_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Describe the new feature and its purpose.

## 📌 Related Issues / Tasks

Link any related issues or task IDs.

## ✅ Checklist

- [ ] Feature works as expected
- [ ] Code is linted and formatted
- [ ] Tests have been written
- [ ] Docs are updated if needed
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/refactor_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Describe the changes made for code cleanup, restructuring, or optimization.
Clearly mention if the behavior or logic remains unchanged.

## 📂 Why Refactor?

Explain the motivation behind the refactor.
For example: improve readability, performance, maintainability, or remove duplication.

## 🔗 Related Issues / Tasks

Link any related issue, task, or technical debt ticket.

## ✅ Checklist

- [ ] No breaking changes introduced
- [ ] Code behavior remains consistent (if applicable)
- [ ] Code is cleaner and easier to maintain
- [ ] All tests still pass
- [ ] New tests added for refactored parts (if needed)
- [ ] Documentation updated (if needed)
7 changes: 7 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
👋 **Please select the appropriate PR template from the list.**

- [New Feature](./PULL_REQUEST_TEMPLATE/feature_template.md)
- [Bug Fix](./PULL_REQUEST_TEMPLATE/bugfix_template.md)
- [Refactor](./PULL_REQUEST_TEMPLATE/refactor_template.md)
Comment on lines +3 to +5

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The links to the PR templates are currently relative file paths. While this works for browsing the repository, a more user-friendly approach for PR creation is to use query parameters. This allows users to click a link and have the corresponding template pre-filled on the 'New Pull Request' page.

Suggested change
- [New Feature](./PULL_REQUEST_TEMPLATE/feature_template.md)
- [Bug Fix](./PULL_REQUEST_TEMPLATE/bugfix_template.md)
- [Refactor](./PULL_REQUEST_TEMPLATE/refactor_template.md)
- [New Feature](?template=feature_template.md)
- [Bug Fix](?template=bugfix_template.md)
- [Refactor](?template=refactor_template.md)


_Ensure your PR title starts with `[feature]`, `[bugfix]`, or `[refactor]` so labels are added automatically._
34 changes: 34 additions & 0 deletions .github/workflows/label-pr-by-title.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: 🔖 Label PRs by Title

on:
pull_request:
types: [opened, edited, reopened, synchronize]

jobs:
labeler:
runs-on: ubuntu-latest
steps:
- name: 🏷️ Add labels based on PR title
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
const title = context.payload.pull_request.title.toLowerCase();
const labels = [];

if (title.startsWith('[feature]')) {
labels.push('type:feature');
} else if (title.startsWith('[bugfix]')) {
labels.push('type:bugfix');
} else if (title.startsWith('[refactor]')) {
labels.push('type:refactor');
}

if (labels.length > 0) {
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.payload.pull_request.number,
labels
});
}
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"cSpell.words": ["maxlength", "Parens", "pino", "trivago"],
"cSpell.words": ["Ansopedia", "maxlength", "Parens", "pino", "trivago"],
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll": "always",
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This Code of Conduct applies within all community spaces, and also applies when

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email address]. All complaints will be reviewed and investigated promptly and fairly.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email address](mailto:group.ansopedia@gmail.com). 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.

Expand Down
14 changes: 6 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ By participating in this project, you agree to uphold our [Code of Conduct](./CO
- A **Contributor** is any individual who creates an issue/PR, comments on an issue/PR, or contributes in some other way.
- A **Collaborator** is a contributor with write access to the repository. See [here](#becoming-a-collaborator) on how to become a collaborator.

You can find more details and guides about Collaborating with this repository through our [Collaborator Guide](./COLLABORATOR_GUIDE.md).

### Becoming a Collaborator

A collaborator of the Ansopedia and its repository is a member of the Ansopedia Team.
Expand Down Expand Up @@ -72,9 +70,9 @@ Once you've forked the repository, clone it to your local machine:
Clone your fork using SSH, GitHub CLI, or HTTPS.

```bash
git clone git@github.com:ansopedia/notification-service.git # SSH
git clone https://github.com/ansopedia/notification-service.git # HTTPS
gh repo clone ansopedia/notification-service # GitHub CLI
git clone git@github.com:<YOUR_USERNAME>/notification-service.git # SSH
git clone https://github.com/<YOUR_USERNAME>/notification-service.git # HTTPS
gh repo clone <YOUR_USERNAME>/notification-service # GitHub CLI
```

#### 3. Change into the notification-service directory.
Expand All @@ -88,7 +86,7 @@ cd notification-service
Create a new branch for your feature, bug fix, or documentation update:

```bash
git checkout -b <name-of-your-branch>
git checkout -b <name-of-your-branch>
```

#### 5. **Install Dependencies**
Expand Down Expand Up @@ -126,7 +124,7 @@ git commit -m "Add new feature for notification registration"
Push your changes to your forked Repository on GitHub:

```bash
git push -u origin name-of-your-branch
git push -u origin name-of-your-branch
```

#### 10. **Create a Pull Request (PR)**
Expand Down Expand Up @@ -168,7 +166,7 @@ Ensure that your code adheres to the existing coding standards and passes all te

### Pre-commit Hooks

This project uses [Husky][] for Git pre-commit hooks.
This project uses [Husky](https://typicode.github.io/husky/) for Git pre-commit hooks.

### When merging

Expand Down
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2014 The Android Open Source Project
Copyright 2025 Ansopedia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand All @@ -198,4 +198,4 @@
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
limitations under the License.