From a34126cc4e06016eab4ba8219ef8d56626a0e329 Mon Sep 17 00:00:00 2001 From: LucasCtrl Date: Fri, 2 Oct 2020 17:44:58 +0200 Subject: [PATCH 1/2] :memo: Add issue templates --- .github/ISSUE_TEMPLATE/---bug-report.md | 21 +++++++++++++++++++ .github/ISSUE_TEMPLATE/---feature-request.md | 22 ++++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/---bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/---feature-request.md diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md new file mode 100644 index 0000000..b23bd60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -0,0 +1,21 @@ +--- +name: "\U0001F41B Bug Report" +about: "If something isn't working as expected \U0001F914" +title: '' +labels: bug +assignees: '' +--- + +## Bug Report + +**Current Behavior** +A clear and concise description of the behavior. + +**Expected behavior/code** +A clear and concise description of what you expected to happen (or code). + +**Possible Solution** + + +**Additional context/Screenshots** +Add any other context about the problem here. If applicable, add screenshots to help explain. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md new file mode 100644 index 0000000..75583de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/---feature-request.md @@ -0,0 +1,22 @@ +--- +name: "\U0001F680 Feature Request" +about: "I have a suggestion (and may want to implement it \U0001F642)!" +title: '' +labels: enhancement +assignees: '' +--- + +## Feature Request + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I have an issue when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. Add any considered drawbacks. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Teachability, Documentation, Adoption, Migration Strategy** +If you can, explain how users will be able to use this and possibly write out a version the docs. +Maybe a screenshot or design? \ No newline at end of file From a24ad07bcd1fb9695a7becbab55ec414ad2507f1 Mon Sep 17 00:00:00 2001 From: LucasCtrl Date: Fri, 2 Oct 2020 18:08:39 +0200 Subject: [PATCH 2/2] :zap: Improve README.md --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0319a31..4081d21 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ -# spookyBot -🎃 A spooky Discord bot +# SpookyBot +🎃 *A spooky Discord bot* + +[![release](https://img.shields.io/github/release/LucasCtrl/spookyBot.svg?style=flat-square&logo=github&logoColor=fafafa&colorA=191b25&colorB=32cb8b)](https://github.com/LucasCtrl/spookyBot/releases/latest) +[![issues](https://img.shields.io/github/issues/LucasCtrl/spookyBot.svg?style=flat-square&colorA=191b25)](https://github.com/LucasCtrl/spookyBot/issues) +[![stars](https://img.shields.io/github/stars/LucasCtrl/spookyBot.svg?style=flat-square&colorA=191b25)](https://github.com/LucasCtrl/spookyBot/stargazers) +[![forks](https://img.shields.io/github/forks/LucasCtrl/spookyBot.svg?style=flat-square&colorA=191b25)](https://github.com/LucasCtrl/spookyBot/network) + +## 👤 Author + +**LucasAlt** +* Website: https://www.lucasalt.fr +* Twitter: [@LucasCtrlAlt](https://twitter.com/LucasCtrlAlt) +* GitHub: [@LucasCtrl](https://github.com/LucasCtrl) + +## 🤝 Contributing + +This project is convenient for people who want to get into open source and contribute to different projects especially during the Hacktoberfest. +If you want to add your language to the robot, feel free to copy the `./lang/en.js` file, rename it following the [following nomenclature](http://www.mathguide.de/info/tools/languagecode.html). + +Then, all you have to do is modify the file, open a pull request and wait for me to approve it and update the robot. + +*Don't hesitate to ask me for help on my [Discord server](https://discord.gg/nEDcagb), I would help you with great pleasure!* + +1. Fork it (https://github.com/LucasCtrl/spookyBot/fork) +2. Create your feature branch (`git checkout -b feature/fooBar`) +3. Commit your changes (`git commit -am 'Add some fooBar'`) +4. Push to the branch (`git push origin feature/fooBar`) +5. Create a new Pull Request + +## Show your support + +Give a ⭐️ if you like this project! + + + Buy Me a Coffee at ko-fi.com + + +## 📝 License + +This project is open source and available under the [MIT](https://github.com/LucasCtrl/spookyBot/blob/master/LICENSE)