From 60d5a63296e8395436b9a7e88dba00c3e09117f3 Mon Sep 17 00:00:00 2001 From: Uday Vunnam Date: Thu, 28 Mar 2024 23:58:24 +0530 Subject: [PATCH] feat: github actions --- .github/CODEOWNERS | 2 + .github/FUNDING.yml | 12 +++ .github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++ .github/ISSUE_TEMPLATE/custom.md | 7 ++ .github/ISSUE_TEMPLATE/feature_request.md | 21 +++++ .github/code_of_conduct.md | 76 ++++++++++++++++++ .github/contributing.md | 93 +++++++++++++++++++++++ .github/pull_request_template.md | 11 +++ .github/release-drafter.yml | 13 ++++ .github/semantic.yml | 22 ++++++ .github/stale.yml | 19 +++++ .github/workflows/auto-comment.yml | 24 ++++++ 12 files changed, 328 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/custom.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/code_of_conduct.md create mode 100644 .github/contributing.md create mode 100644 .github/pull_request_template.md create mode 100644 .github/release-drafter.yml create mode 100644 .github/semantic.yml create mode 100644 .github/stale.yml create mode 100644 .github/workflows/auto-comment.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..770fca36 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ + +* @udayvunnam diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..9a704528 --- /dev/null +++ b/.github/FUNDING.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..a42816e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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:** + +

+
+
+
+## 🔥 Exception or Error
+
+

+
+
+
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md new file mode 100644 index 00000000..96a47352 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -0,0 +1,7 @@ +--- +name: Custom issue template +about: Describe this issue template's purpose here. +title: '' +labels: '' +assignees: '' +--- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..d6ba85c6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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? diff --git a/.github/code_of_conduct.md b/.github/code_of_conduct.md new file mode 100644 index 00000000..7b75d641 --- /dev/null +++ b/.github/code_of_conduct.md @@ -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 uday4vunnam@gmail.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/.github/contributing.md b/.github/contributing.md new file mode 100644 index 00000000..2dea68a5 --- /dev/null +++ b/.github/contributing.md @@ -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**: + +``` +(): + + + +