This repository has been archived by the owner on Oct 30, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'openness_apps/master' into openness_rel…
…ease_2009 Conflicts: applications/sample-app/go.mod
- Loading branch information
Showing
6 changed files
with
665 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,15 @@ | ||
# SPDX-License-Identifier: Apache-2.0 | ||
# Copyright (c) 2020 Intel Corporation | ||
|
||
dist: bionic | ||
language: go | ||
go: | ||
- 1.12.x | ||
|
||
before_install: | ||
- curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $GOPATH/bin v1.25.1 | ||
- sudo apt-get install -y shellcheck | ||
- sudo apt-get install -y pylint | ||
|
||
script: | ||
- ./run_ci_build.sh |
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 OpenNESS maintainers. 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,94 @@ | ||
<!-- omit in toc --> | ||
# Contribution Guide | ||
Welcome to the Open Network Edge Services Software (OpenNESS) project. OpenNESS is an open-source solution that is enriched by people like — you. Your contributions drive the network & enterprise edge computing! | ||
|
||
The rest of this document consists of the following sections: | ||
|
||
- [Code of Conduct](#code-of-conduct) | ||
- [Maintainers](#maintainers) | ||
- [Technical Steering Committee](#technical-steering-committee) | ||
- [Submitting Changes](#submitting-changes) | ||
- [Contribution Acceptance Flow](#contribution-acceptance-flow) | ||
- [How to report an issue/bug/enhancement](#how-to-report-an-issuebugenhancement) | ||
- [OpenNESS Release Schedule](#openness-release-schedule) | ||
- [Resources](#resources) | ||
- [Style Guide / Coding conventions](#style-guide--coding-conventions) | ||
- [Where can I ask for help?](#where-can-i-ask-for-help) | ||
- [License](#license) | ||
|
||
## Code of Conduct | ||
We at the OpenNESS community adhere to [Contributor Covenant](https://www.contributor-covenant.org/) as our Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated. | ||
|
||
Instances of abusive, harassing or otherwise unacceptable behavior should be reported by contacting [email protected]. | ||
|
||
## Maintainers | ||
Maintainers act as the gatekeeper to the code - ensuring that coding standards, quality, and functionality of code are maintained by the contributors. Any additions to the source code must be approved by the appropriate maintainer before they are added. The maintainers' role include: | ||
|
||
* Ensuring that any code submitted is of the appropriate quality. | ||
* Ensuring that any code submitted is accompanied with appropriate documentation. | ||
* Ensuring that any code submitted has been reviewed by peers. | ||
* Ensuring that the relevant documentation is kept up to date with the code. | ||
* Ensuring that any identified bugs in the relevant code are captured in the issues backlog. | ||
* Ensuring that the unit, integration, and regression tests are appropriate for the relevant components. | ||
* Ensuring that the contribution does not infringe others' Intellectual Property or the appropriate license and that it is in compliance with [Developer Certificate of Origin](http://developercertificate.org/). | ||
* Answering questions/emails on the relevant areas of the OpenNESS code base. | ||
|
||
## Technical Steering Committee | ||
Any contributor can ask for a topic to be added to the Technical Steering Committee agenda by sending an email to [email protected]. The committee members will add any topic of interest to the agenda. The minutes of Technical Steering Committee meetings will be published within a reasonable time. | ||
|
||
The Technical Steering Committee roles include: | ||
|
||
* Voting on all matters requiring a decision from the Technical Steering Committee. | ||
* Resolving any technical disputes. Anybody who disagree with the resolution of a technical issue can request that the Technical Steering Committee review the issue and make a decision on it. All reasonable steps to resolve the dispute via consensus should be taken before escalating to the Technical Steering Committee. If the Technical Steering Committee Chair concludes that this has not happened, they can refer the issue back to the complainant to take further action before escalating it to the Technical Steering Committee. The decision of the Technical Steering Committee on any technical disputes will be final and all project contributors are expected to comply. If a Maintainer or Committer fails to comply with a decision of the Technical Steering Committee, the Technical Steering Committee will may take any necessary steps to enforce its decision, including replacing the Maintainer/Committer. | ||
* Any new project repositories must be approved by the Technical Steering Committee. | ||
|
||
## Submitting Changes | ||
Inbound contributions are done through [pull requests](https://github.com/open-ness/edgeapps/pulls) which include code changes, enhancements, bug fixes or new applications/features. If you are getting started, you may refer to Github's [how-to](https://help.github.com/articles/using-pull-requests/). With your contributions, we expect that you: | ||
|
||
* certify that you wrote and/or have the right to submit the pull request, | ||
* agree with the [Developer Certificate of Origin](http://developercertificate.org/), | ||
* sign-off your contribution with `Signed-off-by` tag in the commit message(s) | ||
* comply with OpenNESS [licensing](#license), | ||
* pass all Continuous Integration & Continuous Delivery (CI/CD) tools' checks, | ||
* test and verify the proper behaviour of your code, and | ||
* accompany the contribution with good quality documentation. | ||
|
||
Signing off the contribution is performed by the command `git commit --signoff` which certifies that you wrote it or otherwise have the right to pass it on as an open-source contribution. | ||
|
||
Application contributors have the implicit commitment to continually support their applications in whenever a bug is discovered or a test is broken due to the publication of a new release. | ||
|
||
It is always admired when application contributors provide end-to-end acceptance test methods. | ||
|
||
Big contributions, ideas or controversial features should be discussed with the developers' community and with the Technical Steering Committee through a Request for Comments (RFC). This is an essential early step to bring everybody to a common level of understanding so that when the final implementation is pushed, there will be common consensus of the acceptability of the contribution and smooth integration of it to the mainline. Requests for Comments should be submitted through a pull request prefixed with `[RFC]` in the title. | ||
|
||
## Contribution Acceptance Flow | ||
1. A contributor creates a pull request with their changes. | ||
2. Continuous Integration & Continuous Delivery (CI/CD) tools will be automatically triggered and their results are returned into the pull request. | ||
3. The contributor resolves all findings reported by CI/CD verifications. | ||
4. The contributor invites reviewers to the pull request and addresses their comments/feedback. | ||
5. Every pull request must receive 2 approvals in order to go forward with merging. | ||
6. The maintainer(s) must review and ensure that the change(s) introduced by the pull request meets the acceptance criteria. | ||
6. Merging the pull requests can only be performed by the maintainer(s). | ||
|
||
## How to report an issue/bug/enhancement | ||
It is encouraged to use the [GitHub Issues](https://github.com/open-ness/edgeapps/issues) tool to report any bug, issue, enhancement or to seek help. | ||
|
||
## Resources | ||
Below are some useful resources for getting started with OpenNESS: | ||
* [OpenNESS release notes](https://github.com/open-ness/specs/blob/master/openness_releasenotes.md) | ||
* [OpenNESS solution index](https://github.com/open-ness/specs/blob/master/README.md) | ||
* [OpenNESS architecture and solution overview](https://github.com/open-ness/specs/blob/master/doc/architecture.md) | ||
* [OpenNESS getting started guide — network edge](https://github.com/open-ness/specs/blob/master/doc/getting-started/network-edge/controller-edge-node-setup.md) | ||
* [OpenNESS getting started guide — on-premises](https://github.com/open-ness/specs/blob/master/doc/getting-started/on-premises/controller-edge-node-setup.md) | ||
* [OpenNESS application onboarding — network edge](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/network-edge-applications-onboarding.md) | ||
* [OpenNESS application onboarding — on-premises](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/on-premises-applications-onboarding.md) | ||
* [OpenNESS application development and porting guide](https://github.com/open-ness/specs/blob/master/doc/applications/openness_appguide.md) | ||
|
||
## Style Guide / Coding conventions | ||
All contributions must follow the [Development Guide](DEVELOPING.md). | ||
|
||
## Where can I ask for help? | ||
General queries or discussions can be exercised on the OpenNESS developers' mailing list: [[email protected]](mailto:[email protected]). | ||
|
||
## License | ||
OpenNESS is licensed under [Apache License, Version 2.0](LICENSE). By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms. |
Oops, something went wrong.