https://github.com/icon-community/template-repository
You can use this repository as a template if you would like
https://github.com/icon-community/template-repository
Last synced: 19 days ago
JSON representation
You can use this repository as a template if you would like
- Host: GitHub
- URL: https://github.com/icon-community/template-repository
- Owner: icon-community
- License: other
- Created: 2023-01-03T22:53:49.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T23:24:50.000Z (over 2 years ago)
- Last Synced: 2024-10-30T20:45:20.332Z (6 months ago)
- Size: 13.7 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-icon - Template repository - Template repository for a new project, including README, Issue Templates, PR Template, LICENSE, Release message auto-instructions, CONTRIBUTING, and CODE_OF_CONDUCT files (Templates)
README
[![License][license-badge]][license-url]
[![OpenSSF Scorecard][openssf-scorecard-badge]](https://api.securityscorecards.dev/projects/github.com/icon-project/icon-bridge)
# Project title
Briefly describe what your project does.
Table of Contents
## Features
* List project features here
#### Out of scope
Optional section. Briefly clarify anything that could be considered to be in scope but are not.
If this section is removed, please also be sure to remove it from the table of contents.
## Getting Started
Simple and easy instructions on setting up your project locally.
### Prerequisites
List software prerequisites here in the format of the example below.
* docker
```sh
brew install docker
```
### Installation
List installation steps in the format of the example below.
1. Clone the repo
```sh
git clone https://github.com/icon-project/REPO-NAME.git
```
2. Install project dependencies
```sh
yarn install
```
## Usage
Examples of how the project is intended to be used.
_For more examples, please refer to the [documentation][docs]._
## Contributing
If you want to contribute, be sure to review the [contributing guidelines][contributing].
We use GitHub Issues for tracking requests and bugs, and Github Discussions for general questions and discussion.
The project strives to abide by generally accepted best practices in open-source software development.
## License
Distributed under the PROJECT-LICENSE License. See [LICENSE][license-url] for more information.
[license-badge]: https://img.shields.io/github/license/icon-project/REPO-NAME.svg
[license-url]: ./LICENSE
[openssf-scorecard-badge]: https://api.securityscorecards.dev/projects/github.com/icon-project/REPO-NAME/badge
[docs]: ./docs
[contributing]: ./CONTRIBUTING.md
[report-bug]: https://github.com/icon-project/REPO-NAME/issues/new?assignees=&labels=&template=bug.md&title=
[request-feature]: https://github.com/icon-project/REPO-NAME/issues/new?assignees=&labels=&template=feature.md&title=