Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
galt-tr committed Dec 16, 2023
0 parents commit 84ba411
Show file tree
Hide file tree
Showing 121 changed files with 10,280 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"projectName": "alert-key-p2p",
"projectOwner": "galt-tr",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 100,
"commit": false,
"commitConvention": "none",
"contributorsPerLine": 7,
"contributorsSortAlphabetically": false,
"contributors": [
{
"login": "mrz1836",
"name": "Mr. Z",
"avatar_url": "https://avatars.githubusercontent.com/u/3743002?v=4",
"profile": "https://mrz1818.com",
"contributions": [
"infra",
"security"
]
},
{
"login": "galt-tr",
"name": "Dylan",
"avatar_url": "https://avatars.githubusercontent.com/u/64976002?v=4",
"profile": "https://github.com/galt-tr",
"contributions": [
"infra",
"code",
"maintenance",
"security"
]
}
]
}
30 changes: 30 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Auto detect text files and perform LF normalization
* text=auto

# Collapse generated and vendored files on GitHub
AUTHORS linguist-generated merge=union
*.gen.* linguist-generated merge=ours
*.pb.go linguist-generated merge=ours
*.pb.gw.go linguist-generated merge=ours
go.sum linguist-generated merge=ours
go.mod linguist-generated
gen.sum linguist-generated merge=ours
depaware.txt linguist-generated linguist-vendored merge=union
vendor/* linguist-vendored
rules.mk linguist-vendored
*/vendor/* linguist-vendored

# doc
docs/* linguist-documentation
docs/Makefile linguist-documentation=false

# Reduce conflicts on markdown files
*.md merge=union

# A set of files you probably don't want in distribution
/.github export-ignore
/.githooks export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.gitmodules export-ignore
/tool/lint export-ignore
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Default is the repo owner
* @galt-tr
52 changes: 52 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Code of Merit

1. The project creators, lead developers, core team, constitute
the managing members of the project and have final say in every decision
of the project, technical or otherwise, including overruling previous decisions.
There are no limitations to this decisional power.

2. Contributions are an expected result of your membership on the project.
Don't expect others to do your work or help you with your work forever.

3. All members have the same opportunities to seek any challenge they want
within the project.

4. Authority or position in the project will be proportional
to the accrued contribution. Seniority must be earned.

5. Software is evolutive: the better implementations must supersede lesser
implementations. Technical advantage is the primary evaluation metric.

6. This is a space for technical prowess; topics outside of the project
will not be tolerated.

7. Non technical conflicts will be discussed in a separate space. Disruption
of the project will not be allowed.

8. Individual characteristics, including but not limited to,
body, sex, sexual preference, race, language, religion, nationality,
or political preferences are irrelevant in the scope of the project and
will not be taken into account concerning your value or that of your contribution
to the project.

9. Discuss or debate the idea, not the person.

10. There is no room for ambiguity: Ambiguity will be met with questioning;
further ambiguity will be met with silence. It is the responsibility
of the originator to provide requested context.

11. If something is illegal outside the scope of the project, it is illegal
in the scope of the project. This Code of Merit does not take precedence over
governing law.

12. This Code of Merit governs the technical procedures of the project not the
activities outside of it.

13. Participation on the project equates to agreement of this Code of Merit.

14. No objectives beyond the stated objectives of this project are relevant
to the project. Any intent to deviate the project from its original purpose
of existence will constitute grounds for remedial action which may include
expulsion from the project.

This document is the Code of Merit (<del>`http://code-of-merit.org`</del>), version 1.0.
34 changes: 34 additions & 0 deletions .github/CODE_STANDARDS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Code Standards

This project uses the following code standards and specifications from:
- [effective go](https://golang.org/doc/effective_go.html)
- [go benchmarks](https://golang.org/pkg/testing/#hdr-Benchmarks)
- [go examples](https://golang.org/pkg/testing/#hdr-Examples)
- [go tests](https://golang.org/pkg/testing/)
- [godoc](https://godoc.org/golang.org/x/tools/cmd/godoc)
- [gofmt](https://golang.org/cmd/gofmt/)
- [golangci-lint](https://golangci-lint.run/)
- [report card](https://goreportcard.com/)

### *effective go* standards
View the [effective go](https://golang.org/doc/effective_go.html) standards documentation.

### *golangci-lint* specifications
The package [golangci-lint](https://golangci-lint.run/usage/quick-start) runs several linters in one package/cmd.

View the active linters in the [configuration file](../.golangci.yml).

Install via macOS:
```shell
brew install golangci-lint
```

Install via Linux and Windows:
```shell
# binary will be $(go env GOPATH)/bin/golangci-lint
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.31.0
golangci-lint --version
```

### *godoc* specifications
All code is written with documentation in mind. Follow the best practices with naming, examples and function descriptions.
17 changes: 17 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# How to contribute

Please send a GitHub Pull Request to with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). The more tests the merrier. Please follow the coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

## Testing

All tests follow the standard Go testing pattern.
- [Go Tests](https://golang.org/pkg/testing/)
- [Go Examples](https://golang.org/pkg/testing/#hdr-Examples)
- [Go Benchmarks](https://golang.org/pkg/testing/#hdr-Benchmarks)

## Coding conventions

This project follows [effective Go standards](https://golang.org/doc/effective_go.html) and uses additional convention tools:
- [godoc](https://godoc.org/golang.org/x/tools/cmd/godoc)
- [golangci-lint](https://golangci-lint.run/)
- [GoReportCard.com](https://goreportcard.com/)
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# These are supported funding model platforms

github: galt-tr
#custom: https://mrz1818.com/?tab=tips&utm_source=github&utm_medium=sponsor-link&utm_campaign=go-template&utm_term=go-template&utm_content=go-template
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: [bug-p3]
assignees:
- galt-tr
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Please fill the form below.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
validations:
required: true
- type: textarea
id: reproducible
attributes:
label: How can we reproduce this?
description: Please share a public repository (or CodePen, GoPlayground) that reproduces the issue.
validations:
required: true
- type: checkboxes
id: search
attributes:
label: Search
options:
- label: I did search for other open and closed issues before opening this.
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct (located in `.github/`)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- type: textarea
id: ctx
attributes:
label: Additional context
description: Anything else you would like to add
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question
url: https://github.com/galt-tr/alert-key-p2p/discussions
about: Ask questions and discuss with other community members
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Feature request
description: Got a new feature, improvement or idea?
title: "[Feature]: "
labels: [feature]
assignees:
- galt-tr
body:
- type: textarea
id: what-feature
attributes:
label: What's the feature
description: What is it, how does it work, why should it exist?
validations:
required: true
- type: checkboxes
id: search
attributes:
label: Search
options:
- label: I did search for other open and closed issues before opening this.
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct (located in `.github/`)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- type: textarea
id: ctx
attributes:
label: Additional context
description: Anything else you would like to add
validations:
required: false
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Question
description: Do you have a question, comment or concern?
title: "[Question]: "
labels: [question]
assignees:
- galt-tr
body:
- type: textarea
id: question
attributes:
label: What's your question?
description: A clear and concise question using references to specific regions of code if applicable.
validations:
required: true
- type: checkboxes
id: search
attributes:
label: Search
options:
- label: I did search for other open and closed issues before opening this.
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct (located in `.github/`)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- type: textarea
id: ctx
attributes:
label: Additional context
description: Anything else you would like to add
validations:
required: false
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!-- thank you for your contribution! ❤️ -->
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!-- thank you for your contribution! ❤️ -->
34 changes: 34 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Security Policy

## 🔐 Reporting Security Issues

> Please do not open issues that might have security implications!
>
> It is critical that security related issues are reported privately to ensure we have time to address them before they become public.
Vulnerabilities can be reported by getting in touch with the project stakeholder(s):

- [project maintainers](mailto:dylan.murray@bsvblockchain.org)

Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:

- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
- Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue
- Environment (e.g. Linux / Windows / macOS)
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit the issue

This information will help us triage your report more quickly.

## Supported & Maintained Versions

| Version | Supported |
|---------|--------------------|
| 0.x.x | :white_check_mark: |

## Preferred Languages

We prefer all communications to be in English.
28 changes: 28 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Support

> This project has a [code of conduct](./CODE_OF_CONDUCT.md).
> By interacting with this repository, organization, or community you agree to abide by its terms.
Hi! :wave: We're excited that you're using this project, and we'd love to help. To help us help you, please read through the following guidelines.

Please understand that the people involved with this project often do so for fun, next to their day job; you are not entitled to free customer service.

## Questions

Help us help you!

Spending time framing a question and adding support links or resources makes it much easier for us to help. It’s easy to fall into the trap of asking something too specific when you’re close to a problem. Then, those trying to help you out have to spend a lot of time asking additional questions to understand what you are hoping to achieve.

Spending the extra time up front can help save everyone time in the long run.

* Try to define what you need help with:
* Is there something in particular you want to do?
* What problem are you encountering and what steps have you taken to try and fix it?
* Is there a concept you’re not understanding?
* Have you tried checking out the documentation?
* Check out the tips on [requesting support](./CONTRIBUTING.md) in the contributing guide
* The more time you put into asking your question, the better we can help you

## Contributions

See [CONTRIBUTING.md](./CONTRIBUTING.md) on how to contribute.
Loading

0 comments on commit 84ba411

Please sign in to comment.