Skip to content

Commit 10b64c0

Browse files
authored
Merge pull request #1 from krakend/initial_implementation
Initial implementation
2 parents 03a506c + f238a31 commit 10b64c0

File tree

96 files changed

+26072
-64
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+26072
-64
lines changed

CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
38+
39+
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.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to KrakenD-OTEL, there are several ways
4+
you can contribute and make this project more awesome, please see below:
5+
6+
## Reporting an Issue
7+
8+
If you believe you have found an issue with the code please do not hesitate to file an issue in [Github](https://github.com/krakend/krakend-otel/issues). When
9+
filing the issue please describe the problem with the maximum level of detail
10+
and the steps to reproduce the problem, including information about your
11+
environment.
12+
13+
You can also open an issue requesting for help or doing a question and it's
14+
also a good way of contributing since other users might be in a similar
15+
position.
16+
17+
Please note we have a [code of conduct](./CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
18+
19+
## Code Contributions
20+
21+
When contributing to this repository, it is generally a good idea to discuss
22+
the change with the owners before investing a lot of time coding. The process
23+
could be:
24+
25+
1. Open an issue explaining the improvment or fix you want to add
26+
2. [Fork the project](https://github.com/krakend/krakend-otel/fork)
27+
3. Code it in your fork
28+
4. Submit a [pull request](https://help.github.com/articles/creating-a-pull-request) referencing the issue
29+
30+
31+
Your work will then be reviewed as soon as possible (suggestions about some
32+
changes, improvements or alternatives may be given).
33+
34+
**Don't forget to add tests**, make sure that they all pass!
35+
36+
# Help with Git
37+
38+
Once the repository is forked, you should track the upstream (original) one
39+
using the following command:
40+
41+
git remote add upstream https://github.com/krakend/krakend-otel.git
42+
43+
Then you should create your own branch:
44+
45+
git checkout -b <prefix>/<micro-title>-<issue-number>
46+
47+
Once your changes are done (`git commit -am '<descriptive-message>'`), get the
48+
upstream changes:
49+
50+
git checkout master
51+
git pull --rebase origin master
52+
git pull --rebase upstream master
53+
git checkout <your-branch>
54+
git rebase master
55+
56+
Finally, publish your changes:
57+
58+
git push -f origin <your-branch>
59+
60+
You should be now ready to make a pull request.

Makefile

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
test:
2+
go test ./client/...
3+
go test ./config/...
4+
go test ./exporter/...
5+
go test ./io/...
6+
go test ./lura/...
7+
go test ./state/...
8+
go test ./router/...
9+
.PHONY: test

0 commit comments

Comments
 (0)