-
-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
27f36ac
commit 60d5a63
Showing
12 changed files
with
328 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
|
||
* @udayvunnam |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# These are supported funding model platforms | ||
|
||
github: udayvunnam # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] | ||
custom: https://www.paypal.me/udayvunnam # Replace with a single custom sponsorship URL | ||
patreon: # Replace with a single Patreon username | ||
open_collective: # Replace with a single Open Collective username | ||
ko_fi: # Replace with a single Ko-fi username | ||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
liberapay: # Replace with a single Liberapay username | ||
issuehunt: # Replace with a single IssueHunt username | ||
otechie: # Replace with a single Otechie username |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
name: '🐞 Bug report' | ||
about: Report a bug in xng-breadcrumb | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
--- | ||
|
||
## 🐞 Bug report | ||
|
||
### Description | ||
|
||
#### 🔬 Minimal Reproduction | ||
|
||
#### 💻Your Environment | ||
|
||
**Angular Version:** | ||
|
||
<pre><code> | ||
<!-- run `ng --version` and paste output below --> | ||
<!-- ✍️--> | ||
|
||
## 🔥 Exception or Error | ||
|
||
<pre><code> | ||
<!-- If the issue is accompanied by an exception or an error, please share it below: --> | ||
<!-- ✍️--> | ||
</code></pre> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
name: Custom issue template | ||
about: Describe this issue template's purpose here. | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
name: '🧩 Feature request' | ||
about: Suggest an idea for xng-breadcrumb | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
--- | ||
|
||
## 🧩 Feature request | ||
|
||
### Description | ||
|
||
<!-- ✍️--> A clear and concise description of the problem or missing capability... | ||
|
||
### Describe the solution you'd like | ||
|
||
<!-- ✍️--> If you have a solution in mind, please describe it. | ||
|
||
### Describe alternatives you've considered | ||
|
||
<!-- ✍️--> Have you considered any alternative solutions or workarounds? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# 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 [email protected]. 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
## Contributing | ||
|
||
[fork]: /fork | ||
[pr]: /compare | ||
[style]: https://prettier.io | ||
[code-of-conduct]: CODE_OF_CONDUCT.md | ||
|
||
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. | ||
|
||
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms. | ||
|
||
## Submitting a pull request | ||
|
||
1. [Fork][fork] and clone the repository | ||
2. Configure and install the dependencies: `pnpm install` | ||
3. Make sure the tests pass on your machine: `pnpm e2e` | ||
4. Create a new branch: `git checkout -b my-branch-name` | ||
5. Make your change, add tests, and make sure the tests still pass | ||
6. A pre-commit hook will make sure that your code is properly formatted, but you can also manually check for linting or formatting errors by running `pnpm lint` | ||
7. Push to your fork and [submit a pull request][pr] | ||
8. Pat yourself on the back and wait for your pull request to be reviewed and merged. | ||
|
||
Here are a few things you can do that will increase the likelihood of your pull request being accepted: | ||
|
||
- Follow the [style guide][style] which is using Prettier. | ||
- Write and update tests. | ||
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. | ||
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
|
||
Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you. | ||
|
||
## Commit Message Format | ||
|
||
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special | ||
format that includes a **type**, a **scope** and a **subject**: | ||
|
||
``` | ||
<type>(<scope>): <subject> | ||
<BLANK LINE> | ||
<body> | ||
<BLANK LINE> | ||
<footer> | ||
``` | ||
|
||
The **header** is mandatory and the **scope** of the header is optional. | ||
|
||
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier | ||
to read on GitHub as well as in various git tools. | ||
|
||
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any. | ||
|
||
Samples: | ||
|
||
``` | ||
feat(lib): add new shortcut | ||
``` | ||
|
||
``` | ||
docs: update examples | ||
The version in our package.json gets copied to the one we publish, and users need the latest of these. | ||
``` | ||
|
||
### Revert | ||
|
||
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted. | ||
|
||
### Type | ||
|
||
Must be one of the following: | ||
|
||
- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | ||
- **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | ||
- **docs**: Documentation only changes | ||
- **feat**: A new feature | ||
- **fix**: A bug fix | ||
- **perf**: A code change that improves performance | ||
- **refactor**: A code change that neither fixes a bug nor adds a feature | ||
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | ||
- **test**: Adding missing tests or correcting existing tests | ||
|
||
### Scope | ||
|
||
The following is the list of supported scopes: | ||
|
||
- **app** - Demo app | ||
- **lib** - Library | ||
|
||
## Resources | ||
|
||
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) | ||
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) | ||
- [GitHub Help](https://help.github.com) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# What is this PR about | ||
|
||
<!-- ✍️--> A clear and concise description... | ||
|
||
## PR Checklist | ||
|
||
Please check if your PR fulfils the following requirements: | ||
|
||
- [x] The commit message follows [the guidelines](./contributing.md#commit) | ||
- [ ] Tests for the changes have been added (for bug fixes/features) | ||
- [ ] Docs have been added/updated (for bug fixes/features) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name-template: v$NEXT_PATCH_VERSION | ||
categories: | ||
- title: 🚀 Features | ||
label: feature | ||
- title: 🐛 Bug Fixes | ||
label: fix | ||
- title: 🧰 Maintenance | ||
label: chore | ||
tag-template: $TITLE @$AUTHOR (#$NUMBER) | ||
template: | | ||
## Changes | ||
$CHANGES |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# https://github.com/zeke/semantic-pull-requests#configuration | ||
titleOnly: true | ||
scopes: | ||
- breadcrumb-demo | ||
- demo | ||
- app-demo | ||
- simple-demo | ||
- xng-breadcrumb | ||
- lib | ||
types: | ||
- feat | ||
- fix | ||
- docs | ||
- style | ||
- refactor | ||
- perf | ||
- test | ||
- build | ||
- ci | ||
- chore | ||
- revert | ||
allowEmptyScope: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# https://github.com/probot/stale#usage | ||
|
||
# Number of days of inactivity before an issue becomes stale | ||
daysUntilStale: 120 | ||
# Number of days of inactivity before a stale issue is closed | ||
daysUntilClose: 120 | ||
# Issues with these labels will never be considered stale | ||
exemptLabels: | ||
- pinned | ||
- security | ||
# Label to use when marking an issue as stale | ||
staleLabel: wontfix | ||
# Comment to post when marking an issue as stale. Set to `false` to disable | ||
markComment: > | ||
This issue has been automatically marked as stale because it has not had | ||
recent activity. It will be closed if no further activity occurs. Thank you | ||
for your contributions. | ||
# Comment to post when closing a stale issue. Set to `false` to disable | ||
closeComment: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
name: Auto Comment | ||
on: [issues, pull_request] | ||
jobs: | ||
run: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: bubkoo/[email protected] | ||
with: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
issuesOpenedReactions: 'eyes, +1' | ||
issuesOpenedComment: > | ||
Hello 👋 @{{ author }} | ||
<br> | ||
Thank you for raising an issue. We will investigate into the issue and get back to you as soon as possible. | ||
Please make sure you have given us as much context as possible. | ||
<br> | ||
Feel free to raise a PR if you can fix the issue. Check the [local development guide](https://github.com/udayvunnam/xng-breadcrumb/blob/main/docs/local-development-guide.md) | ||
pullRequestOpenedReactions: 'hooray, +1' | ||
pullRequestOpenedComment: > | ||
Hello 👋 @{{ author }} | ||
<br> | ||
Thank you for raising your pull request. | ||
Please make sure you have followed our [contributing guidelines](https://github.com/udayvunnam/xng-breadcrumb/blob/main/.github/contributing.md). We will review it as soon as possible. |