Skip to content

Commit

Permalink
Update .gitignore, package.json, index.js, CONTRIBUTING.md, README.md…
Browse files Browse the repository at this point in the history
…, and LICENSE files
  • Loading branch information
Jagoda11 committed Mar 25, 2024
1 parent e2dec80 commit adf1dc8
Show file tree
Hide file tree
Showing 11 changed files with 5,951 additions and 1,041 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/ci-workflow.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: CI Workflow

on:
push:
branches: [main]

jobs:
build:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [21.x]

steps:
- name: 🔄 Checkout code
uses: actions/checkout@v2
- name: 🔧 Set up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- name: 📦 Install dependencies
run: npm ci
- name: 🧪 Run tests
run: npm run test
env:
CI: true

deploy:
needs: build
runs-on: ubuntu-latest
steps:
- name: 🚀 Deploy
run: echo "Replace this with your deployment commands"
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ lib
*.log
coverage/
dist/
/test/
/test/fixtures/
80 changes: 26 additions & 54 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,45 @@
# Contributor Covenant Code of Conduct
# 🤝 Contributor Covenant Code of Conduct

## Our Pledge
## 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, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance, race,
religion, or sexual identity and orientation.
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, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards
## Our Standards 📚

Examples of behavior that contributes to creating a positive environment
include:
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
- 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
- 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
## 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 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.
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
## 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.
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
## Enforcement 🚔

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at . 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.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue in our [project repository](https://github.com/Jagoda11/rupert-the-bot). 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.
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
## 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
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
[homepage]: https://www.contributor-covenant.org
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## 🤝 Contributing

[fork]: /fork
[pr]: /compare
[fork]: https://github.com/Jagoda11/rupert-the-bot/fork
[pr]: https://github.com/Jagoda11/rupert-the-bot/compare
[code-of-conduct]: CODE_OF_CONDUCT.md

Hello there! 👋 We're thrilled that you're considering contributing to this project. Your help is essential for keeping it great. 🙌
Expand Down
8 changes: 4 additions & 4 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
ISC License
📜 ISC License

Copyright (c) 2024, Jagoda11
Copyright (c) 2024, Jagoda Cubrilo

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
copyright notice and this permission notice appear in all copies. 📄

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ⚖️
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,34 @@
# rupert-the-bot
# 🤖 rupert-the-bot

> A GitHub App built with [Probot](https://github.com/probot/probot) that This is a Github app
## Setup
## 🛠️ Setup

```sh
# Install dependencies
npm install

# Run the bot
npm start
```

# Run the tests
npm test

## Docker

```sh
# 1. Build container
docker build -t rupert-the-bot .

# 2. Start container
docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> rupert-the-bot
```

## Contributing
## 🤝 Contributing

If you have suggestions for how rupert-the-bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the [Contributing Guide](CONTRIBUTING.md).

## License
To contribute, you can [fork this repository](https://github.com/Jagoda11/rupert-the-bot/fork).

## 📜 License

[ISC](LICENSE) © 2024 Jagoda Cubrilo
[ISC](LICENSE) © 2024 Jagoda Cubrilo
22 changes: 11 additions & 11 deletions app.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# This is a GitHub App Manifest. These settings will be used by default when
# 📝 This is a GitHub App Manifest. These settings will be used by default when
# initially configuring your GitHub App.
#
# NOTE: changing this file will not update your GitHub App settings.
# NOTE: changing this file will not update your GitHub App settings.
# You must visit github.com/settings/apps/your-app-name to edit them.
#
# Read more about configuring your GitHub App:
# 📚 Read more about configuring your GitHub App:
# https://probot.github.io/docs/development/#configuring-a-github-app
#
# Read more about GitHub App Manifests:
# 📚 Read more about GitHub App Manifests:
# https://developer.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/

# The list of events the GitHub App subscribes to.
# 📮 The list of events the GitHub App subscribes to.
# Uncomment the event names below to enable them.
default_events:
# - check_run
Expand Down Expand Up @@ -47,7 +47,7 @@ default_events:
# - team_add
# - watch

# The set of permissions needed by the GitHub App. The format of the object uses
# 🛠️ The set of permissions needed by the GitHub App. The format of the object uses
# the permission name for the key (for example, issues) and the access type for
# the value (for example, write).
# Valid values are `read`, `write`, and `none`
Expand Down Expand Up @@ -123,15 +123,15 @@ default_permissions:
# Get notified of, and update, content references.
# https://developer.github.com/v3/apps/permissions/
# organization_administration: read
# The name of the GitHub App. Defaults to the name specified in package.json
# 📛 The name of the GitHub App. Defaults to the name specified in package.json
# name: My Probot App

# The homepage of your GitHub App.
# 🏠 The homepage of your GitHub App.
# url: https://example.com/

# A description of the GitHub App.
# 📝 A description of the GitHub App.
# description: A description of my awesome app

# Set to true when your GitHub App is available to the public or false when it is only accessible to the owner of the app.
# 🌐 Set to true when your GitHub App is available to the public or false when it is only accessible to the owner of the app.
# Default: true
# public: false
# public: false
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default (app) => {

app.on('issues.opened', async (context) => {
const issueComment = context.issue({
body: '👋 Thanks for opening this issue! 🙌',
body: '👋 Thanks for opening this issue! 🙌 🎉 🚀',
});
return context.octokit.issues.createComment(issueComment);
});
Expand Down
Loading

0 comments on commit adf1dc8

Please sign in to comment.