Skip to content

Commit b46fed4

Browse files
VictorAvelarVictorAvelar
committed
chore(docs): update generated docs
1 parent eb83878 commit b46fed4

File tree

17 files changed

+1310
-0
lines changed

17 files changed

+1310
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at `avocatlsoftware@gmail.com`. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

‎.github/CONTRIBUTING.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/avocatl/slugger).
6+
7+
## Before starting to code
8+
9+
If you are contributing based on an issue, please drop a comment in the issue so that it can be labeled as `in progress` and assigned to you, this provides everyone visiting the repository with a clear overview of what is up for grabs and what is already taken.
10+
11+
Also be sure to ask and clarify all your questions so that your coding experience is as smooth as possible.
12+
13+
If your PR is not based on an issue, then please provide a relevant and descriptive PR description and branch name.
14+
15+
## Pull Requests
16+
17+
- **Passes code style checks**
18+
19+
- **Add tests!** - Your code won't be accepted if it doesn't have tests.
20+
21+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
22+
23+
- **Create feature branches** - Don't ask us to pull from your master branch.
24+
25+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
26+
27+
- **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](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
28+
29+
30+
## Running Tests
31+
32+
``` bash
33+
$ go test -v -race ./...
34+
```
35+
36+
**Happy coding**!

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ['bug', 'help-wanted']
6+
7+
---
8+
9+
**Describe the bug**
10+
<!-- A clear and concise description of what the bug is. -->
11+
12+
**To Reproduce**
13+
<!-- Steps to reproduce the behavior: -->
14+
15+
**Expected behavior**
16+
<!-- A clear and concise description of what you expected to happen. -->
17+
18+
**Screenshots**
19+
<!-- If applicable, add screenshots to help explain your problem. -->
20+
21+
**Desktop (please complete the following information):**
22+
23+
<!-- - OS: [e.g. iOS]
24+
- Version [e.g. 22] -->
25+
26+
**Smartphone (please complete the following information):**
27+
28+
<!-- - Device: [e.g. iPhone6]
29+
- OS: [e.g. iOS8.1]
30+
- Browser [e.g. stock browser, safari]
31+
- Version [e.g. 22] -->
32+
33+
**Additional context**
34+
<!-- Add any other context about the problem here. -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
# Description
3+
4+
<!-- Describe your changes in detail. -->
5+
6+
## Motivation and context
7+
8+
<!-- Why is this change required? What problem does it solve?
9+
10+
If it fixes an open issue, please link to the issue here (if you write `fixes #num`
11+
or `closes #num`, the issue will be automatically closed when the pull is accepted.) -->
12+
13+
## How has this been tested?
14+
15+
<!-- Please describe in detail how you tested your changes.
16+
17+
Include details of your testing environment, and the tests you ran to
18+
see how your change affects other areas of the code, etc. -->
19+
20+
- [ ] Unit tests added / updated
21+
- [ ] The tests run on docker (using `task test`)
22+
23+
<!-- If you are running the tests locally, please specify: -->
24+
25+
<!-- - OS: [e.g. ubuntu/macos/windows]
26+
- Go version [e.g. 1.19.x] -->
27+
28+
## Types of changes
29+
30+
<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply:
31+
32+
- [ ] Bug fix (non-breaking change which fixes an issue)
33+
- [ ] New feature (non-breaking change which adds functionality)
34+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
35+
- [ ] This change requires a documentation update -->
36+
37+
## Checklist
38+
39+
<!-- Go over all the following points, and put an `x` in all the boxes that apply.
40+
41+
Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our continuous integration server to make sure your [tests and code style pass](https://help.github.com/articles/about-required-status-checks/). -->
42+
43+
- [x] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
44+
- [x] My pull request addresses exactly one patch/feature.
45+
- [x] I have created a branch for this patch/feature.
46+
- [x] Each individual commit in the pull request is meaningful.
47+
- [x] If my change requires a change to the documentation, I have updated it accordingly.
48+
49+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

‎.github/dependabot.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: gomod
4+
directory: "/"
5+
schedule:
6+
interval: weekly
7+
time: "04:00"
8+
open-pull-requests-limit: 10
9+
10+
- package-ecosystem: github-actions
11+
directory: ".github/workflows"
12+
schedule:
13+
interval: daily
14+
target-branch: master
15+
open-pull-requests-limit: 5

‎.github/labeler.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
tests:
2+
- changed-files:
3+
- any-glob-to-any-file: ["./*_test.go"]
4+
5+
documentation:
6+
- changed-files:
7+
- any-glob-to-any-file: ["docs/*"]
8+
9+
gh-actions:
10+
- changed-files:
11+
- any-glob-to-any-file: [".github/**/*.yml"]
12+
13+
core:
14+
- changed-files:
15+
- any-glob-to-any-file: ["./*.go", "!./*_tests.go", "!./tools/*"]
16+
17+
modules:
18+
- changed-files:
19+
- any-glob-to-any-file: ["go.*"]
20+
21+
meta-files:
22+
- changed-files:
23+
- any-glob-to-any-file:
24+
["Taskfile", "README.md", "LICENSE", "SECURITY.md"]

‎.github/stale.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Number of days of inactivity before an issue becomes stale
2+
daysUntilStale: 5
3+
# Number of days of inactivity before a stale issue is closed
4+
daysUntilClose: 10
5+
# Issues with these labels will never be considered stale
6+
exemptLabels:
7+
- pinned
8+
- security
9+
- question
10+
- request-info
11+
- documentation
12+
- investigation
13+
# Label to use when marking an issue as stale
14+
staleLabel: stale
15+
# Comment to post when marking an issue as stale. Set to `false` to disable
16+
markComment: >
17+
This issue has been automatically marked as stale because it has not had
18+
recent activity. It will be closed if no further activity occurs. Thank you
19+
for your contributions.
20+
# Comment to post when closing a stale issue. Set to `false` to disable
21+
closeComment: >
22+
This issue has been automatically closed because it has not had
23+
any activity after being labeled as staled.

‎.github/workflows/codeql-analysis.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: "CodeQL"
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths-ignore:
7+
- "**.md"
8+
- "*.yml"
9+
- "*.yaml"
10+
- "Taskfile"
11+
- "docs/*.md"
12+
- ".gitignore"
13+
- "LICENSE"
14+
- ".github/*.yml"
15+
- ".github/ISSUE_TEMPLATE/*.md"
16+
- ".github/*.md"
17+
- ".github/workflows/main.yml"
18+
- ".github/workflows/release.yml"
19+
schedule:
20+
- cron: "21 11 * * 4"
21+
22+
jobs:
23+
analyze:
24+
name: Analyze
25+
runs-on: ubuntu-latest
26+
permissions:
27+
actions: read
28+
contents: read
29+
security-events: write
30+
31+
strategy:
32+
fail-fast: false
33+
matrix:
34+
language: ["go"]
35+
36+
steps:
37+
- name: Checkout repository
38+
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
39+
40+
# Initializes the CodeQL tools for scanning.
41+
- name: Initialize CodeQL
42+
uses: github/codeql-action/init@81644f35ff20aa6b0e7b936f0e8716419ba7d295
43+
with:
44+
languages: "go"
45+
- name: Autobuild
46+
uses: github/codeql-action/autobuild@81644f35ff20aa6b0e7b936f0e8716419ba7d295
47+
48+
- name: Perform CodeQL Analysis
49+
uses: github/codeql-action/analyze@81644f35ff20aa6b0e7b936f0e8716419ba7d295

‎.github/workflows/labeler.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "PR label assigner"
2+
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
branches:
7+
- master
8+
pull_request_target:
9+
branches:
10+
- master
11+
12+
jobs:
13+
triage:
14+
permissions:
15+
checks: write
16+
contents: read
17+
pull-requests: write
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/labeler@634933edcd8ababfe52f92936142cc22ac488b1b
21+
with:
22+
repo-token: "${{ secrets.GITHUB_TOKEN }}"
23+
sync-labels: true

‎.github/workflows/linter.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
concurrency:
2+
cancel-in-progress: true
3+
group: ${{ github.repository }}-${{ github.workflow }}-${{ github.ref }}
4+
5+
on:
6+
push:
7+
branches:
8+
- master
9+
paths-ignore:
10+
- "**.md"
11+
- "*.yml"
12+
- "Makefile"
13+
- "docs/*.md"
14+
- ".gitignore"
15+
- "LICENSE"
16+
- ".github/*.yml"
17+
- ".github/ISSUE_TEMPLATE/*.md"
18+
- ".github/*.md"
19+
- ".github/workflows/main.yml"
20+
- ".github/workflows/release.yml"
21+
pull_request:
22+
paths-ignore:
23+
- "**.md"
24+
- "*.yml"
25+
- "Makefile"
26+
- "docs/*.md"
27+
- ".gitignore"
28+
- "LICENSE"
29+
- ".github/*.yml"
30+
- ".github/ISSUE_TEMPLATE/*.md"
31+
- ".github/*.md"
32+
- ".github/workflows/main.yml"
33+
- ".github/workflows/release.yml"
34+
jobs:
35+
golangci:
36+
name: linter
37+
runs-on: ubuntu-latest
38+
permissions:
39+
contents: read
40+
pull-requests: read
41+
checks: write
42+
steps:
43+
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
44+
with:
45+
fetch-depth: "0"
46+
- uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5
47+
with:
48+
go-version: 1.x
49+
- uses: golangci/golangci-lint-action@1e7e51e771db61008b38414a730f564565cf7c20
50+
with:
51+
version: latest
52+
install-mode: binary

0 commit comments

Comments
 (0)