Skip to content

Commit a8a390d

Browse files
author
Douglas
committed
Added CREDITS.md and README.md, renamed LICENSE to LICENSE.md
1 parent 6e700a5 commit a8a390d

File tree

3 files changed

+52
-0
lines changed

3 files changed

+52
-0
lines changed

CREDITS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Credits
2+
3+
This project is maintained by [RedNeckSnailSpit](https://github.com/RedNeckSnailSpit).
4+
5+
## Author
6+
- **RedNeckSnailSpit**
7+
- Main Site: [RedNeckSnailSpit](https://rednecksnailspit.co.za/)
8+
- GitHub: [RedNeckSnailSpit](https://github.com/RedNeckSnailSpit/)
9+
- X (formerly Twitter): [RNSnailSpit](https://x.com/RNSnailSpit)
10+
11+
## Contributor Policy
12+
We welcome contributions from the community! Contributors who actively help improve this project may be acknowledged in this credit list. Whether you’ve contributed code, documentation, or other valuable resources, we appreciate your efforts.
13+
14+
Please note that inclusion in this list is at the discretion of the repository maintainers. Contributions will be reviewed for their significance and alignment with the goals of this project before deciding to recognize the contributor here.

LICENSE renamed to LICENSE.md

File renamed without changes.

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Issue Automation Test
2+
3+
This project demonstrates an automated GitHub issue creation process. It dynamically detects errors, generates detailed reports, and submits them as issues to a specified GitHub repository.
4+
5+
## Features
6+
- Automatically detects runtime errors (exceptions).
7+
- Dynamically retrieves and confirms the repository name.
8+
- Creates detailed GitHub issues with error details, stack traces, and unique exception hashes to prevent duplicates.
9+
- Includes a setup process for saving configuration data (`config.json`) - **Note: Saves in plain text**
10+
11+
## Usage
12+
### Prerequisites
13+
- Python 3.10 or higher.
14+
- A GitHub account with access to the desired repository.
15+
- A Personal Access Token (PAT) with the following scopes:
16+
- `repo` (for private repositories).
17+
- `public_repo` (for public repositories).
18+
19+
### Setup Process
20+
1. Clone this repository:
21+
```bash
22+
git clone https://github.com/RedNeckSnailSpit/IssueAutomationTest.git
23+
```
24+
2. Navigate to the repository directory:
25+
```bash
26+
cd IssueAutomationTest
27+
```
28+
3. Run the script as-is and go through the setup process.
29+
```bash
30+
python main.py
31+
```
32+
4. Once completed, you should see the `config.json` file in the repository - Keep this file safe, it contains your GitHub token.
33+
34+
## Credit
35+
Please see the [CREDITS](CREDITS.md) for this project.
36+
37+
## License
38+
Please see the [LICENSE](LICENSE.md) for this project.

0 commit comments

Comments
 (0)