forked from mubeng/mubeng
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 15a5027
Showing
53 changed files
with
2,061 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Contributing | ||
|
||
By participating to this project, you agree to abide our [code of conduct](https://github.com/kitabisa/mubeng/blob/master/.github/CODE_OF_CONDUCT.md). | ||
|
||
## Development | ||
|
||
For small things like fixing typos in documentation, you can [make edits through GitHub](https://help.github.com/articles/editing-files-in-another-user-s-repository/), which will handle forking and making a pull request (PR) for you. For anything bigger or more complex, you'll probably want to set up a development environment on your machine, a quick procedure for which is as folows: | ||
|
||
|
||
### Setup your machine | ||
|
||
`mubeng` is written in [Go](https://golang.org/). | ||
|
||
Prerequisites: | ||
|
||
- make | ||
- [Go 1.15+](https://golang.org/doc/install) | ||
|
||
Fork and clone **[mubeng](https://github.com/kitabisa/mubeng)** repository. | ||
|
||
A good way of making sure everything is all right is running the following: | ||
|
||
```bash | ||
▶ make build | ||
▶ ./bin/mubeng -h | ||
``` | ||
|
||
### Test your change | ||
|
||
When you are satisfied with the changes, we suggest you run: | ||
|
||
```bash | ||
▶ make test-extra | ||
``` | ||
|
||
Which runs all the linters and tests. | ||
|
||
### Submit a pull request | ||
|
||
As you are ready with your code contribution, push your branch to your `mubeng` fork and open a pull request against the **master** branch. | ||
|
||
Please also update the [CHANGELOG.md](https://github.com/kitabisa/mubeng/blob/master/CHANGELOG.md) to note what you've added or fixed. | ||
|
||
### Pull request checks | ||
|
||
By submitting your pull request, you are agreeing to our [Contributing License Agreement](https://github.com/kitabisa/mubeng/blob/master/.github/CONTRIBUTION_LICENSE_AGREEMENT.md). | ||
|
||
Also, we run a few checks in CI by using GitHub actions, you can see them [here](https://github.com/kitabisa/mubeng/tree/master/.github/workflows). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# CONTRIBUTION LICENSE AGREEMENT | ||
|
||
This Contribution License Agreement (the “CLA”) is between the individual set forth in the signature block (“You”) and mubeng, (“Kitabisa”), effective as of the date of Your signature and sets forth the terms pursuant to which You provides Contributions to Kitabisa. | ||
|
||
You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Kitabisa. In return, Kitabisa will not use Your Contributions in a way that is contrary to Kitabisa’s business objectives. Except for the license granted herein to Kitabisa and recipients of software distributed by Kitabisa, You reserve all right, title, and interest in and to Your Contributions. | ||
|
||
Definitions. “Contribution” means any original work of authorship, including any modifications or additions to an existing work, that You intentionally submit to Kitabisa for inclusion in, or documentation of, any of the products owned or managed by Kitabisa (the “Work”). “Submit” means any form of electronic, verbal, or written communication sent to Kitabisa or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Kitabisa for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Contribution.” | ||
|
||
Copyright License. Subject to the terms and conditions of this CLA, You hereby grant to Kitabisa and to recipients of software distributed by Kitabisa a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to use, copy, reproduce, prepare derivative works of, sublicense, distribute and publicly perform and display the Contributions on any licensing terms, including without limitation: (a) open source licenses like the MIT license; and (b) binary, proprietary, or commercial licenses. | ||
|
||
Patent License. Subject to the terms and conditions of this CLA, You hereby grant to Kitabisa and to recipients of software distributed by Kitabisa a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that Your Contribution, or the Work to which You have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this CLA for that Contribution or Work will terminate as of the date such litigation is filed. | ||
|
||
Representations and Warranties. You represent and warrant to Kitabisa that: | ||
|
||
You are legally entitled to grant the above license, and if Your employer(s) has rights to intellectual property that You create that includes Your Contributions, then You represent and warrant that You have received permission to make Contributions on behalf of that employer, that Your employer has waived such rights for Your Contributions to Kitabisa, or that Your employer has executed a separate CLA with Kitabisa; | ||
|
||
Each of Your Contributions is Your original creation (see section 6 for submissions on behalf of others); and | ||
|
||
Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which You are personally aware and which are associated with any part of Your Contributions. | ||
|
||
Support; Disclaimer. You are not expected to provide support for Your Contributions, except to the extent You desire to do so. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. | ||
|
||
Third Party Works. If You wish to submit work that is not Your original creation, then You may submit it to Kitabisa separately from any Contribution, identifying the complete details of it. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: "[BUG]" | ||
labels: 'Status: On Hold, Type: Bug' | ||
assignees: dwisiswant0 | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
|
||
Steps to reproduce the behavior: | ||
|
||
```yaml | ||
> mubeng [-c|a :8080] [options...] | ||
``` | ||
|
||
**Expected behavior** | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
|
||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Environment (please complete the following information):** | ||
|
||
- OS: [e.g. mac, linux] | ||
- OS version: [uname -a] | ||
- mubeng Version: | ||
|
||
**Additional context** | ||
Add any other context about the problem here. Full output log is probably a helpful thing to add here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Ask a question | ||
url: https://github.com/kitabisa/mubeng/discussions | ||
about: Ask questions and discuss with other community members |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Documentation | ||
about: Suggest better docs coverage for a particular tool or process. | ||
title: "[DOCS]" | ||
labels: 'Status: On Hold, Type: Documentation' | ||
--- | ||
|
||
<!-- | ||
To make it easier for us to help you, please include as much useful information as possible. | ||
Before opening a new issue, please search existing issues https://github.com/kitabisa/mubeng/issues | ||
--> | ||
|
||
## Summary | ||
|
||
_What problem(s) did you run into that caused you to request additional documentation? What questions do you think we should answer? What, if any, existing documentation relates to this proposal?_ | ||
|
||
Some recommended topics to cover: | ||
|
||
- _List the topics you think should be here._ | ||
- _This list does not need to be exhaustive!_ | ||
|
||
### Motivation | ||
|
||
_Why should we document this and who will benefit from it?_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: "[FEATURE]" | ||
labels: 'Status: On Hold' | ||
assignees: dwisiswant0 | ||
|
||
--- | ||
|
||
**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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
**IMPORTANT: Please do not create a Pull Request without creating an issue first!** | ||
|
||
_(Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request)._ | ||
|
||
### Summary | ||
|
||
<!-- Please provide enough information so that others can review your pull request. --> | ||
<!-- For more information, see the CONTRIBUTING.md guide. --> | ||
|
||
_Explains the information and/ motivation for making this changes..._ | ||
|
||
|
||
### Proposed of changes | ||
|
||
This PR fixes/implements the following **bugs/features**: | ||
|
||
- Bug 1 | ||
- Bug 2 | ||
- Feature 1 | ||
- Feature 2 | ||
- Breaking changes | ||
|
||
<!-- What existing problem does the pull request solve? --> | ||
|
||
### How has this been tested? | ||
|
||
Proof: | ||
|
||
<!-- Demonstrate the code is solid. Example: The exact commands you ran and their output or/ screenshots. --> | ||
|
||
### Closing issues | ||
|
||
Fixes # | ||
|
||
### Checklist: | ||
|
||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
|
||
- [ ] My code follows the code style of this project. | ||
- [ ] My change requires a change to the documentation. | ||
- [ ] I have updated the documentation accordingly. | ||
- [ ] I have followed the guidelines in our [CONTRIBUTING.md](https://github.com/kitabisa/mubeng/blob/master/.github/CONTRIBUTING.md) document. | ||
- [ ] I have written new tests for my changes. | ||
- [ ] My changes successfully ran and pass tests locally. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Security Policy | ||
When I started out **mubeng**, I had very little or no knowledge on Golang. So I believe there could be many security vulnerabilities. | ||
|
||
The community will be thankful to your contributions. :star: | ||
|
||
## Reporting a Vulnerability | ||
|
||
Please report the security vulnerabilities via Issues Section or email `infosec<at>kitabisa.com` | ||
|
||
<!-- ## Past Security Vulnerabilities --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: "gomod" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" | ||
labels: | ||
- "Type: Maintenance" | ||
|
||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" | ||
labels: | ||
- "Type: Maintenance" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: Contributors | ||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
contributors: | ||
name: "Update contributors" | ||
runs-on: ubuntu-latest | ||
if: contains(github.event.head_commit.message, '[ci skip]') == false && contains(github.event.head_commit.message, '[skip ci]') == false | ||
steps: | ||
- uses: bubkoo/contributors-list@v1 | ||
with: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
commitMessage: "misc: Update CONTRIBUTORS" | ||
svgPath: .github/CONTRIBUTORS.svg | ||
userNameHeight: 19 | ||
itemTemplate: > | ||
<g transform="translate({{ x }}, {{ y }})"> | ||
<a xlink:href="{{{ url }}}" class="contributor-link" target="_blank" rel="nofollow sponsored" title="{{{ name }}}" id="{{{ name }}}"> | ||
<image width="{{ width }}" height="{{ height }}" xlink:href="{{{ avatar }}}" /> | ||
<text x="32" y="74" text-anchor="middle" alignment-baseline="middle" font-size="10" font-family="monospace" fill="%2301ACEC">{{{ name }}}</text> | ||
</a> | ||
</g> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: "Gosum" | ||
|
||
on: | ||
push: | ||
branches: | ||
- "master" | ||
paths: | ||
- ".github/workflows/gosum.yaml" | ||
- "go.mod" | ||
- "go.sum" | ||
|
||
jobs: | ||
gosum: | ||
name: "Go mod tidy up" | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Check out code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Go | ||
uses: actions/setup-go@v2 | ||
with: | ||
go-version: 1.14 | ||
|
||
- name: Tidy | ||
run: | | ||
rm -f go.sum | ||
go mod tidy | ||
- name: Create Pull Request | ||
uses: peter-evans/[email protected] | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
commit-message: ":hammer: Tidy up the Go modules" | ||
title: "Tidy up the Go module" | ||
body: | | ||
Current `go.mod` and `go.sum` don't match the source code. | ||
branch: go-mod-tidy | ||
branch-suffix: short-commit-hash | ||
labels: "Type: Maintenance" |
Oops, something went wrong.