Skip to content

Commit cabd6f9

Browse files
CarmendelopeCarmendelope
authored
Merge pull request #22 from napptive/feature/PG-574_Open_Source
prepare repo to open source
2 parents e8a6a2f + 8e7e584 commit cabd6f9

File tree

8 files changed

+120
-73
lines changed

8 files changed

+120
-73
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "Report a bug"
3+
about: Something is not working as expected
4+
title: ""
5+
labels: kind/bug
6+
assignees: ''
7+
---
8+
9+
#### Describe the bug
10+
11+
<!-- describe what happened -->
12+
13+
#### Expected behavior
14+
15+
<!-- describe your expected behavior-->
16+
17+
#### Steps to reproduce it
18+
19+
<!-- any information that can help reproducing the bug -->
20+
21+
#### Versions & environment
22+
23+
<!-- describe the environment in which this bug can be reproduced adding any version information if available -->

‎.github/ISSUE_TEMPLATE/feature_request.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "Feature request"
3+
about: Something an idea for this project
4+
title: ""
5+
labels: kind/feature
6+
assignees: ''
7+
---
8+
9+
#### Is your feature request related to a problem?
10+
11+
<!-- A clear and concise description of what the problem is -->
12+
13+
#### Describe the solution you'd like
14+
15+
<!-- A clear and concise description of what you want to happen. -->
16+
17+
#### Describe alternatives you've considered
18+
19+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
20+
21+
#### Additional context
22+
23+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/workflows/latest.yml

-37
This file was deleted.

‎.github/workflows/release.yml

-33
Original file line numberDiff line numberDiff line change
@@ -57,36 +57,3 @@ jobs:
5757
asset_name: ${{ steps.make_release.outputs.release_name }}
5858
asset_content_type: application/tar+gzip
5959

60-
docker:
61-
name: Push Docker Release Images
62-
runs-on: ubuntu-latest
63-
64-
needs: gh
65-
steps:
66-
- name: Set up Go 1.x
67-
uses: actions/setup-go@v2
68-
with:
69-
go-version: ^1.15
70-
id: go
71-
72-
- name: Configure git for private modules
73-
run: git config --global url."https://${GH_NAPP_USER}:${GH_NAPP_TOKEN}@github.com".insteadOf "https://github.com"
74-
75-
- name: Checkout code
76-
uses: actions/checkout@v2
77-
78-
- name: Get the version
79-
id: get_version
80-
run: echo ::set-output name=version::${GITHUB_REF/refs\/tags\//}
81-
82-
- name: Docker login
83-
uses: docker/login-action@v1
84-
with:
85-
username: ${{secrets.DOCKER_HUB_USER}}
86-
password: ${{secrets.DOCKER_HUB_TOKEN}}
87-
88-
- name: Build and push Docker images
89-
run: make docker-push
90-
env:
91-
VERSION: ${{ steps.get_version.outputs.version }}
92-
TARGET_DOCKER_REGISTRY: napptive

‎code-of-conduct.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Napptive Code of Conduct
2+
3+
Napptive follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
4+
5+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting us via [email protected].

‎contributing.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Contributing
2+
3+
- [Getting Involved](#getting-involved)
4+
- [How to contribute](#how-to-contribute)
5+
- [Open a Pull Request](#open-a-pull-request)
6+
7+
## Getting Involved
8+
9+
Welcome to Napptive! This guide will help you know the necessary steps to contribute to our community.
10+
Please, first of all, read our [code of conduct](link).
11+
12+
## How to contribute
13+
14+
- __Help us to improve documentation.__
15+
16+
- __Have you found a bug?__
17+
We will be very grateful if you inform us oppening an issue.
18+
Be clear and concise in the definition of the bug. Indicate the steps to reproduce it, which version you are using, on which platform. Include any additional information that may help to understand the bug.
19+
20+
- __Open an issue.__
21+
Do you see something that needs work? Do you have any new ideas? Would you like to discuss any functionality? Feel free to open an issue. Fill the issue template being as clear and concise as you can.
22+
23+
- __Have you found a security problem?__
24+
We would appreciate if you could send us a message to [email protected] informing us of the problem
25+
26+
If you have any questions, you don’t know how to contribute, or you need help, feel free to use [Napptive’s Gitter](https://gitter.im/napptive/community), and we will be happy to help you.
27+
28+
## Open a Pull Request
29+
30+
Please:
31+
32+
- Write understandable and clear git commit messages.
33+
- Take care of the quality of the code following the [official guide](https://go.dev/doc/effective_go).
34+
- Use gofmt tool.
35+
- Add comments in the code in order to make it more understandable to the community.
36+
- Be sure to include the corresponding tests (unit test and integration test if proceed)
37+
- Fill all the required information in PR template:
38+
39+
```md
40+
### Checklist
41+
- [ ] Code compiles correctly
42+
- [ ] Created tests which fail without the change (if possible)
43+
- [ ] All tests passing
44+
- [ ] Extended the README/documentation, if necessary
45+
46+
#### What does this PR do?
47+
48+
#### Where should the reviewer start?
49+
50+
#### What is missing?
51+
52+
#### How should this be manually tested?
53+
54+
#### Any background context you want to provide?
55+
56+
#### What are the associated tickets?
57+
58+
#### Screenshots (if appropriate)
59+
60+
#### Questions
61+
62+
```
63+
64+
Be sure to include a clear and detailed PR description that explains the purpose of the PR. Don't forget that the reviewer must know what you are trying to solve, why, and how. Select at least one person to review your PR.
65+
66+
If it is four first contribution, you should sign our CLA document.

‎go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ require (
99
github.com/kr/pretty v0.2.0 // indirect
1010
github.com/napptive/grpc-common-go v0.4.0 // indirect
1111
github.com/napptive/grpc-ping-go v0.1.0
12-
github.com/napptive/nerrors v1.0.0
12+
github.com/napptive/nerrors v1.0.1
1313
github.com/onsi/ginkgo v1.15.0
1414
github.com/onsi/gomega v1.10.5
1515
github.com/rs/xid v1.2.1

‎go.sum

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ github.com/napptive/grpc-common-go v0.4.0 h1:uN6sxr8tidDEPwhVLA6UwnGpNHwuI+QTwWd
4747
github.com/napptive/grpc-common-go v0.4.0/go.mod h1:Q896cZY+yIkted9zYw3jtguVDdfL1bqTHjjiirBTjnw=
4848
github.com/napptive/grpc-ping-go v0.1.0 h1:/hNDGXAOPbGA/jszauggfDG3PcVsfpgrxrS5lLGgfwI=
4949
github.com/napptive/grpc-ping-go v0.1.0/go.mod h1:hBIdzClG9sZCHcq+tYZGNLaZ0TtQZ6s/YIRbNyhKES4=
50-
github.com/napptive/nerrors v1.0.0 h1:LADBxnAFPfsswumOVQC/17IUDJ2EXYsAYWEnXAmgv2o=
51-
github.com/napptive/nerrors v1.0.0/go.mod h1:ZZeFFcm34BFmU8yntdIEngwLbh2btshyPRg/J4fhY+0=
50+
github.com/napptive/nerrors v1.0.1 h1:G+CgLmJ65vSLpISq4A48uj+tgp/EN5o+FWQDGHwVvgo=
51+
github.com/napptive/nerrors v1.0.1/go.mod h1:ZZeFFcm34BFmU8yntdIEngwLbh2btshyPRg/J4fhY+0=
5252
github.com/nxadm/tail v1.4.4 h1:DQuhQpB1tVlglWS2hLQ5OV6B5r8aGxSrPc5Qo6uTN78=
5353
github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A=
5454
github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=

0 commit comments

Comments
 (0)