Skip to content

Commit b8dfcf5

Browse files
fix: broken links
Co-Authored-By: Nexos Dev <152608930+nexospro@users.noreply.github.com>
1 parent 329bfb8 commit b8dfcf5

3 files changed

Lines changed: 38 additions & 30 deletions

File tree

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ISC License
22

3-
Copyright (c) 2024, Nexos Creator
3+
Copyright (c) 2024, Nexos Labs
44

55
Permission to use, copy, modify, and/or distribute this software for any
66
purpose with or without fee is hereby granted, provided that the above

README.md

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
# 🚀 GitHub Bot Template
2-
31
[![Probot](https://img.shields.io/badge/Built%20with-Probot-blue.svg)](https://probot.github.io/)
42
[![TypeScript](https://badgen.net/badge/Built%20with/TypeScript/blue)](https://www.typescriptlang.org/)
53
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)
64

7-
Welcome to the **GitHub Bot Template**! 🤖
8-
This repository provides a robust template for building your own GitHub bot using [Probot](https://probot.github.io/) and TypeScript. The bot automates common workflows like handling issues, pull requests, and notifications while being highly extensible.
5+
# 🚀 GitHub Bot Template
6+
7+
> This repository provides a robust template for building your own GitHub bot using [Probot](https://probot.github.io/) and TypeScript. The bot automates common workflows like handling issues, pull requests, and notifications while being highly extensible.
98
109
---
1110

12-
## 🎯 **Features**
11+
## 🎯 Features
1312

1413
- 📝 **Issue Automation**: Automatically triage issues with labels, comments, and assignments.
1514
- 🔍 **Pull Request Workflow**: Streamline code reviews with reviewer assignment, comments, and more.
@@ -19,22 +18,22 @@ This repository provides a robust template for building your own GitHub bot usin
1918

2019
---
2120

22-
## 🚀 **Getting Started**
21+
## 🚀 Getting Started
2322

2423
Follow these steps to get your bot up and running:
2524

26-
### 1️⃣ **Clone the Repository**
25+
### **Clone the Repository**
2726
```bash
2827
git clone https://github.com/nexoslabs/bot-github-template.git
2928
cd bot-github-template
3029
```
3130

32-
### 2️⃣ **Install Dependencies**
31+
### **Install Dependencies**
3332
```bash
3433
npm install
3534
```
3635

37-
### 3️⃣ **Set Up Environment Variables**
36+
### **Set Up Environment Variables**
3837
Create a `.env` file based on the provided `.env.example`:
3938
```plaintext
4039
APP_ID=your_app_id
@@ -43,20 +42,20 @@ WEBHOOK_SECRET=your_webhook_secret
4342
GITHUB_TOKEN=your_personal_access_token
4443
```
4544

46-
### 4️⃣ **Run the Bot**
45+
### **Run the Bot**
4746
```bash
4847
npm start
4948
```
5049

51-
### 5️⃣ **Expose the Bot (Optional)**
50+
### **Expose the Bot (Optional)**
5251
Use a tool like [ngrok](https://ngrok.com/) to expose your bot locally:
5352
```bash
5453
ngrok http 3000
5554
```
5655

5756
---
5857

59-
## 🛠️ **Development**
58+
## 🛠️ Development
6059

6160
### 🧪 **Testing**
6261
Write unit and integration tests to ensure the bot works as expected:
@@ -82,32 +81,41 @@ npm run build
8281

8382
---
8483

85-
## 👥 **Contributing**
84+
## 🤝 Contributing
8685

87-
We 💖 contributions! If you'd like to contribute:
88-
1. Fork the repo and create your branch (`git checkout -b feature/AmazingFeature`).
89-
2. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
90-
3. Push to the branch (`git push origin feature/AmazingFeature`).
91-
4. Open a Pull Request.
86+
We ❤️ contributions! Follow these steps to contribute:
9287

93-
For detailed guidelines, see [`CONTRIBUTING.md`](docs/contributing.md).
88+
1. 🍴 **Fork** the repository
89+
2. 🌿 **Create** a new branch (`git checkout -b feature/AmazingFeature`)
90+
3. 💾 **Commit** your changes (`git commit -m 'Add some AmazingFeature'`)
91+
4. 🚀 **Push** to the branch (`git push origin feature/AmazingFeature`)
92+
5. 🔃 **Open a Pull Request**
9493

9594
---
9695

97-
## 📜 **License**
96+
## 💡 Acknowledgments
9897

99-
This repository is licensed under the MIT License. See [`LICENSE.md`](LICENSE.md) for more information.
98+
- Thanks to the [Probot](https://probot.github.io/) team for their amazing framework.
99+
- Inspired by the open-source community.
100100

101101
---
102102

103-
## 🌟 **Support**
103+
## 📄 License
104104

105-
- Found this template helpful? Give us a ⭐ on GitHub!
106-
- Questions? Open an issue or join the discussion in [`Discussions`](https://github.com/nexoslabs/bot-github-template/discussions).
105+
This project is licensed under **The UnLicense** See the [LICENSE](LICENSE) file for details.
107106

108107
---
109108

110-
## 💡 **Acknowledgments**
109+
## 📬 Contact & Community
111110

112-
- Thanks to the [Probot](https://probot.github.io/) team for their amazing framework.
113-
- Inspired by the open-source community.
111+
💬 Join us on **Discord**: [Click Here](https://discord.gg/H7pVc9aUK2)
112+
🐦 **Follow on Twitter**: [@nexoslabs](https://twitter.com/nexoslabs)
113+
📧 **Email**: [contact@nexoscreation.tech](mailto:contact@nexoscreation.tech)
114+
115+
<p align="center">
116+
Made with ❤️ by the <a href="https://github.com/nexoslabs">@nexoslabs</a> Team
117+
</p>
118+
119+
<p align="center">
120+
<a href="https://github.com/nexoslabs/discord-24-7-rich-presence/stargazers">⭐ Star us on GitHub!</a>
121+
</p>

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
"version": "0.3.0",
44
"private": true,
55
"description": "A Nexos Automation Bot",
6-
"author": "Nexos Creator",
6+
"author": "Nexos Labs",
77
"license": "ISC",
88
"main": "./lib/index.js",
9-
"homepage": "https://github.com/nexoscreation/bot-github-template",
9+
"homepage": "https://github.com/nexoslabs/bot-github-template",
1010
"keywords": [
1111
"probot",
1212
"github",

0 commit comments

Comments
 (0)