Browse Source

Build the basic skeleton

tags/v1.0.0
guanguans 3 years ago
commit
e2fc2e5353
14 changed files with 264 additions and 0 deletions
  1. +15
    -0
      .editorconfig
  2. +12
    -0
      .gitattributes
  3. +53
    -0
      .github/CONTRIBUTING.md
  4. +4
    -0
      .github/FUNDING.yml
  5. +27
    -0
      .github/ISSUE_TEMPLATE/bug_report.md
  6. +20
    -0
      .github/ISSUE_TEMPLATE/feature_request.md
  7. +3
    -0
      .github/SECURITY.md
  8. +50
    -0
      .github/workflows/run-tests.yml
  9. +3
    -0
      .gitignore
  10. +7
    -0
      CHANGELOG.md
  11. +21
    -0
      LICENSE
  12. +0
    -0
      Makefile
  13. +49
    -0
      README.md
  14. +0
    -0
      docs/.gitkeep

+ 15
- 0
.editorconfig View File

@@ -0,0 +1,15 @@
root = true

[*]
charset = utf-8
indent_size = 4
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.{yml,yaml}]
indent_size = 2

+ 12
- 0
.gitattributes View File

@@ -0,0 +1,12 @@
# Path-based git attributes
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html

# Ignore all test and documentation with "export-ignore".
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/.editorconfig export-ignore
/.github export-ignore
/Makefile export-ignore
/CHANGELOG.md export-ignore


+ 53
- 0
.github/CONTRIBUTING.md View File

@@ -0,0 +1,53 @@
# Contributing

Contributions are **welcome** and will be fully **credited**.

Please read and understand the contribution guide before creating an issue or pull request.

## Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

## Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open
source projects are used by many developers, who may have entirely different needs to your own. Think about
whether or not your feature is likely to be used by other users of the project.

## Procedure

Before filing an issue:

- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
- Check to make sure your feature suggestion isn't already present within the project.
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
- Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

- Check the codebase to ensure that your feature doesn't already exist.
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

## Requirements

If the project maintainer has any additional requirements, you will find them listed here.

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

**Happy coding**!

+ 4
- 0
.github/FUNDING.yml View File

@@ -0,0 +1,4 @@
# These are supported funding model platforms

patreon: guanguans
custom: https://www.guanguans.cn/images/wechat.jpeg

+ 27
- 0
.github/ISSUE_TEMPLATE/bug_report.md View File

@@ -0,0 +1,27 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: guanguans

---

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

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

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

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.

+ 20
- 0
.github/ISSUE_TEMPLATE/feature_request.md View File

@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: good idea
assignees: guanguans

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

+ 3
- 0
.github/SECURITY.md View File

@@ -0,0 +1,3 @@
# Security Policy

If you discover any security related issues, please email ityaozm@gmail.com instead of using the issue tracker.

+ 50
- 0
.github/workflows/run-tests.yml View File

@@ -0,0 +1,50 @@
name: Tests

on:
push:
branches: [master]
pull_request:
env:
GOPROXY: "https://proxy.golang.org"

jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Init Go modules
run: go mod init gopkg.in/ini.v1
- name: Run golangci-lint
uses: actions-contrib/golangci-lint@v1

test:
name: Test
strategy:
matrix:
go-version: [1.13.x, 1.14.x, 1.15.x]
platform: [ubuntu-latest, macos-latest, windows-latest]
runs-on: ${{ matrix.platform }}
steps:
- name: Install Go
uses: actions/setup-go@v1
with:
go-version: ${{ matrix.go-version }}
- name: Checkout code
uses: actions/checkout@v2
- name: Run unit tests
run: |
go mod init gopkg.in/ini.v1
go test -v -race -coverprofile=coverage -covermode=atomic ./...
- name: Upload coverage report to Codecov
uses: codecov/codecov-action@v1.0.6
with:
file: ./coverage
flags: unittests
- name: Cache downloaded modules
uses: actions/cache@v1
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-

+ 3
- 0
.gitignore View File

@@ -0,0 +1,3 @@
.idea/
.DS_Store
.history/

+ 7
- 0
CHANGELOG.md View File

@@ -0,0 +1,7 @@
# Changelog

All notable changes to `guanguans/id-validator` will be documented in this file

## 1.0.0 - 2021-xx-xx

* Initial release.

+ 21
- 0
LICENSE View File

@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 琯琯

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

+ 0
- 0
Makefile View File


+ 49
- 0
README.md View File

@@ -0,0 +1,49 @@
# id-validator

> 介绍

![Tests](https://github.com/guanguans/id-validator/workflows/Tests/badge.svg)
![Check & fix styling](https://github.com/guanguans/id-validator/workflows/Check%20&%20fix%20styling/badge.svg)
[![codecov](https://codecov.io/gh/guanguans/id-validator/branch/main/graph/badge.svg?token=URGFAWS6S4)](https://codecov.io/gh/guanguans/id-validator)
[![Latest Stable Version](https://poser.pugx.org/guanguans/id-validator/v)](//packagist.org/packages/guanguans/id-validator)
[![Total Downloads](https://poser.pugx.org/guanguans/id-validator/downloads)](//packagist.org/packages/guanguans/id-validator)
[![License](https://poser.pugx.org/guanguans/id-validator/license)](//packagist.org/packages/guanguans/id-validator)

## Requirement

* Go >= 1.6

## Installation

``` shell script
$ go get ...
```

## Usage

## Testing

``` bash
$ make ...
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

* [guanguans](https://github.com/guanguans)
* [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.

+ 0
- 0
docs/.gitkeep View File


Loading…
Cancel
Save