forked from zowe/api-layer
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Mark Ackert <[email protected]>
- Loading branch information
Mark Ackert
authored and
Mark Ackert
committed
Oct 30, 2018
0 parents
commit c34ba84
Showing
613 changed files
with
87,297 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,14 @@ | ||
# Editor configuration, see http://editorconfig.org | ||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_style = space | ||
indent_size = 4 | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
max_line_length = 120 | ||
|
||
[*.md] | ||
max_line_length = off | ||
trim_trailing_whitespace = false |
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,41 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Logs** | ||
If applicable, add server logs collected at the time of your problem. | ||
|
||
**Details** | ||
- Version: [e.g. 0.9.1] | ||
- Build number: [e.g. #23] | ||
- Test environment: [e.g. A - see https://cawiki.ca.com/x/8hFALw for CA environments] | ||
|
||
**API Catalog Web UI (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**REST API client (please complete the following information):** | ||
- Technology: [e.g. Spring Boot, Node.js] | ||
- OS: [e.g. Windows 10] | ||
|
||
**Additional context** | ||
Add any other context about the problem 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,17 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
**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,86 @@ | ||
# Java | ||
*.class | ||
|
||
# Mobile Tools for Java (J2ME) | ||
.mtj.tmp/ | ||
|
||
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml | ||
hs_err_pid* | ||
|
||
# IDE | ||
*.iml | ||
*.ipr | ||
*.iws | ||
.idea | ||
.vscode | ||
.project | ||
.settings | ||
.classpath | ||
.history | ||
# build folders | ||
build/ | ||
|
||
# UI specific files and directories | ||
node_modules/ | ||
npm-debug.log | ||
api-catalog-services/src/main/resources/static/ | ||
api-catalog-ui/tools | ||
api-catalog-ui/src/main/resources/static | ||
|
||
# Python | ||
*.py[cod] | ||
Pipfile.lock | ||
.pytest_cache | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Packages | ||
*.egg | ||
*.egg-info | ||
dist | ||
eggs | ||
parts | ||
bin | ||
var | ||
sdist | ||
develop-eggs | ||
.installed.cfg | ||
lib | ||
lib64 | ||
__pycache__ | ||
*.jar | ||
*.war | ||
*.ear | ||
|
||
# Installer logs | ||
pip-log.txt | ||
|
||
# Unit test and coverage reports | ||
.tox | ||
nosetests.xml | ||
.coverage | ||
|
||
# Translations | ||
*.mo | ||
|
||
# logs | ||
logs/ | ||
|
||
# pid files | ||
*.pid | ||
|
||
# OS files | ||
.DS_Store | ||
|
||
# Caches | ||
.sts4-cache | ||
.cache | ||
|
||
# Gradle | ||
.gradle/ | ||
!gradle/wrapper/gradle-wrapper.jar | ||
api-catalog-ui/frontend/test-results/*.xml | ||
api-catalog-ui/frontend/debug.log | ||
|
||
debug.log |
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,7 @@ | ||
This program and the accompanying materials are made available under the terms of the | ||
Eclipse Public License v2.0 which accompanies this distribution, and is available at | ||
https://www.eclipse.org/legal/epl-v20.html | ||
|
||
SPDX-License-Identifier: EPL-2.0 | ||
|
||
Copyright Contributors to the Zowe Project. |
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,109 @@ | ||
Contributing | ||
============ | ||
|
||
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. | ||
|
||
You can contribute in many ways: | ||
|
||
Types of Contributions | ||
---------------------- | ||
|
||
### Work on User Stories | ||
|
||
As a member of core development team you will introduce new functionality from | ||
your teams' backlog. | ||
|
||
### Report Bugs | ||
|
||
Report bugs at <https://github.com/gizafoundation/api-layer>. | ||
|
||
If you are reporting a bug, please include: | ||
|
||
- Your operating system name and version. | ||
- Any details about your local setup that might be helpful in troubleshooting. | ||
- Detailed steps to reproduce the bug. | ||
|
||
### Fix Bugs | ||
|
||
Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it. | ||
|
||
### Write Documentation | ||
|
||
The code could always use more documentation, whether as part of the API docs, in documentation strings, | ||
or even in the wiki, in blog posts, articles, and such. | ||
|
||
|
||
Get Started! | ||
============ | ||
|
||
Ready to contribute? Here's how to set up the project for local development. | ||
|
||
We are following [GitHub Flow workflow](https://guides.github.com/introduction/flow/) with the `master` branch. | ||
|
||
Members of core development team (<https://github.com/gizafoundation/api-layer>) are | ||
allowed to create branches in the repository. | ||
|
||
1. Clone the repository: | ||
|
||
- _Core development team_: | ||
|
||
1. Clone the repository locally (creates `api-layer` directory): | ||
|
||
$ git clone https://github.com/gizafoundation/api-layer | ||
|
||
- _Other contributors_: | ||
|
||
1. Fork the repository on GitHub - <https://github.com/gizafoundation/api-layer>. | ||
|
||
2. Clone your fork locally (creates `api-layer` directory): | ||
|
||
$ git clone https://github.com/gizafoundation/api-layer | ||
|
||
2. Create a branch for local development: | ||
|
||
$ git checkout master | ||
$ git checkout -b name-of-your-bugfix-or-feature | ||
|
||
Now you can make your changes locally. | ||
|
||
3. Review information in [README](README.md). | ||
|
||
4. When you're done making changes, check that your changes pass all the tests on your computer and on z/OS. | ||
|
||
5. Commit your changes and push your branch to GitHub: | ||
|
||
$ git add . | ||
$ git commit -m "Your detailed description of your changes." | ||
$ git push origin name-of-your-bugfix-or-feature | ||
|
||
7. Submit a pull request through the GitHub website. | ||
|
||
|
||
Pull Request Guidelines | ||
======================= | ||
|
||
Before you submit a pull request, check that it meets these guidelines: | ||
|
||
1. Review guidelines and advices [How to write the perfect pull request](https://github.com/blog/1943-how-to-write-the-perfect-pull-request) | ||
and [Good Commits](http://vry.cz/post/good-commits/). | ||
The information that you provide helps reviewer to understand the code and review your pull request faster. | ||
It is helpful for understanding the code in future. | ||
2. The pull request should include tests and code coverage for new code should be at least 60%. | ||
Code coverage should not be lower than on master. | ||
3. If the pull request adds functionality, the docs should be updated. | ||
4. Execute all the available automated tests on your machine and on z/OS platform. | ||
5. If the pull request adds or changes functionality that requires update of packaging or configuration, it needs to be tested on a test system installed from the Zowe PAX file and scripts in [zowe-install](/zowe-install) directory need to be updated. | ||
|
||
|
||
Core Development Team | ||
===================== | ||
|
||
Members of core development team (<https://github.com/gizafoundation/api-layer>) are | ||
allowed to create branches in the master repository. | ||
|
||
1. Clone the repository locally (creates `api-layer` directory): | ||
|
||
$ git clone https://github.com/gizafoundation/api-layer | ||
|
||
2. Other instructions are same above. |
Oops, something went wrong.