Skip to content

Commit

Permalink
Modified readme and changelog, implemented pull request othneildrew#85
Browse files Browse the repository at this point in the history
…from original README template repo (author: vi-dev0), and removed files that are unnecessary for my personal use
  • Loading branch information
jt-ziolo committed Jan 17, 2023
1 parent 3552467 commit 0c01049
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 302 deletions.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report---.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: "Bug report \U0001F41E"
about: Create a bug report
labels: bug

---

## Describe the bug
A clear and concise description of what the bug is.

### Steps to reproduce
Steps to reproduce the behavior.

### Expected behavior
A clear and concise description of what you expected to happen.

### Environment
- OS: [e.g. Arch Linux]
- Other details that you think may affect.

### Additional context
Add any other context about the problem here.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request---.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: "Feature request \U0001F680"
about: Suggest an idea
labels: enhancement

---

## Summary
Brief explanation of the feature.

### Basic example
Include a basic example or links here.

### Motivation
Why are we doing this? What use cases does it support? What is the expected outcome?
21 changes: 17 additions & 4 deletions BLANK_README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- Note: This README.md is based upon https://github.com/othneildrew/Best-README-Template. Therefore, comments seen in the source for this README may not be project-specific. -->
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a name="readme-top"></a>
<!--
Expand All @@ -8,6 +9,11 @@
*** Thanks again! Now go create something AMAZING! :D
-->

<!--
Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`, `project_description_full`, `license_name`
Also find/replace on https://example.com
-->


<!-- PROJECT SHIELDS -->
Expand All @@ -22,9 +28,11 @@
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
<!-- If not using the MIT license, replace the first link below. -->
[![MIT License][license-shield]][license-url]
<!-- Opting to comment out LinkedIn shield. Assuming that the project has multiple contributors it seems to me that keeping social media links such as LinkedIn on your profile page is a better approach.
[![LinkedIn][linkedin-shield]][linkedin-url]

-->


<!-- PROJECT LOGO -->
Expand Down Expand Up @@ -85,7 +93,7 @@

[![Product Name Screen Shot][product-screenshot]](https://example.com)

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`
project_description_full

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down Expand Up @@ -179,14 +187,16 @@ Don't forget to give the project a star! Thanks again!
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

More information on getting started contributing to open source may be found [here](https://opensource.guide/how-to-contribute/).

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- LICENSE -->
## License

Distributed under the MIT License. See `LICENSE.txt` for more information.
Distributed under the license_name License. See `LICENSE.txt` for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand All @@ -195,7 +205,7 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
<!-- CONTACT -->
## Contact

Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
JT Ziolo - ziolojt@gmail.com

Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)

Expand All @@ -209,6 +219,7 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/
* []()
* []()
* []()
* This project makes use of [Best-README-Template by othneildrew](https://github.com/othneildrew/Best-README-Template), which is distributed under the MIT License.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand All @@ -226,8 +237,10 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/
[issues-url]: https://github.com/github_username/repo_name/issues
[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge
[license-url]: https://github.com/github_username/repo_name/blob/master/LICENSE.txt
<!--
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/linkedin_username
-->
[product-screenshot]: images/screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
Expand Down
9 changes: 2 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,8 @@
## v1.0.0

### Added or Changed
- Added this changelog :)
- Fixed typos in both templates
- Back to top links
- Added more "Built With" frameworks/libraries
- Changed table of contents to start collapsed
- Added checkboxes for major features on roadmap
- None

### Removed

- Some packages/libraries from acknowledgements I no longer use
- None
21 changes: 0 additions & 21 deletions LICENSE.txt

This file was deleted.

Loading

0 comments on commit 0c01049

Please sign in to comment.