Skip to content

Commit a47de6e

Browse files
authored
Merge pull request #15 from delphi-hub/develop
Updated project infrastructure
2 parents 716a7b3 + 72fc490 commit a47de6e

File tree

6 files changed

+193
-1
lines changed

6 files changed

+193
-1
lines changed

.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. Go to '...'
13+
2. Click on '....'
14+
3. Scroll down to '....'
15+
4. See error
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Affected components (if known)**
24+
Choose those applicable here: crawler, cli, webapi, webapp, management
25+
26+
**Desktop (please complete the following information, if relevant):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information, if relevant):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
Just using "none" is okay here.
16+
17+
**Additional context**
18+
Add any other context or screenshots about the feature request here.

CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contribution Guide
2+
3+
We follow the GitHub [Fork & Pull][forkandpull] and [Git Flow][gitflow] workflow in this project.
4+
Please fork the official repository, develop in a branch based on the
5+
current develop branch, and submit a pull request (PR) after you are done.
6+
7+
[forkandpull]: https://help.github.com/articles/about-pull-requests/
8+
[gitflow]: http://nvie.com/posts/a-successful-git-branching-model/
9+
10+
## Checklist before submitting a Pull Request
11+
12+
Before you submit your PR, please go through this list and check if
13+
your request fulfills these points.
14+
15+
- Do you have more changes/additions/deletions in your PR than you expected?
16+
- Do you have tests for your changes?
17+
- Do all tests of the project succeed?
18+
- Is your pull request based on the `develop` branch? [(cf. GitFlow)][gitflow]
19+
20+
If you check these items before, your pull request is more likely to be
21+
included into the project quickly.
22+

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Delphi Command-Line Interface (CLI)
2+
3+
The command-line interface for the Delphi platform.
4+
5+
We are currently in pre-alpha state! There is no release and the code in
6+
this repository is purely experimental!
7+
8+
|branch | status | codacy |
9+
| :---: | :---: | :---: |
10+
| master | [![Build Status](https://travis-ci.org/delphi-hub/delphi-cli.svg?branch=master)](https://travis-ci.org/delphi-hub/delphi-cli) | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/47046de0e8d64ae4b76191b7dae80075)](https://www.codacy.com/app/delphi-hub/delphi-cli?utm_source=github.com&utm_medium=referral&utm_content=delphi-hub/delphi-cli&utm_campaign=Badge_Grade)|
11+
| develop | [![Build Status](https://travis-ci.org/delphi-hub/delphi-cli.svg?branch=develop)](https://travis-ci.org/delphi-hub/delphi-cli) | |
12+
13+
## What is the Delphi Command-Line Interface?
14+
15+
The Delphi CLI is a tool to access the data on the Delphi platform.
16+
It enables you to search for items matching a query or to inspect a dataset for an item in detail.
17+
It can be used in an automated context to automatically construct fitting item sets.
18+
19+
## How does it work?
20+
21+
The Delphi CLI checks the provided query and passes it on to the web API of the configured platform.
22+
The results are printed to the console by default.
23+
24+
## How can I use it?
25+
26+
The Delphi CLI is running on the Java Virtual Machine.
27+
We require a Java Runtime Environment (JRE) in version 8 or newer.
28+
29+
Our software is available as a binary release on [GitHub](https://github.com/delphi-hub/delphi-cli/releases).
30+
31+
```
32+
$ delphi-cli --help
33+
Delphi Command Line Tool (1.0.0-SNAPSHOT)
34+
Usage: delphi-cli [test|search|retrieve] [options]
35+
36+
--version Prints the version of the command line tool.
37+
--help Prints this help text.
38+
--server <value> The url to the Delphi server
39+
```
40+
By default the command-line tool uses the official Delphi server at https://delphi.cs.uni-paderborn.de to process queries.
41+
You can override this setting using the `--server` option or by setting the `DELPHI_SERVER` environment variable.
42+
43+
## Community
44+
45+
Feel welcome to join our chatroom on Gitter: [![Join the chat at https://gitter.im/delphi-hub/delphi](https://badges.gitter.im/delphi-hub/delphi.svg)](https://gitter.im/delphi-hub/delphi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
46+
47+
48+
## Contributing
49+
50+
Contributions are *very* welcome!
51+
52+
Before contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md).
53+
54+
Refer to the [Contribution Guide](CONTRIBUTING.md) for details about the workflow.
55+
We use Pull Requests to collect contributions. Especially look out for "help wanted" issues
56+
[![GitHub issues by-label](https://img.shields.io/github/issues/delphi-hub/delphi-cli/help%20wanted.svg)](https://github.com/delphi-hub/delphi-cli/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22),
57+
but feel free to work on other issues as well.
58+
You can ask for clarification in the issues directly, or use our Gitter
59+
chat for a more interactive experience.
60+
61+
[![GitHub issues](https://img.shields.io/github/issues/delphi-hub/delphi-cli.svg)](https://github.com/delphi-hub/delphi-cli/issues)
62+
63+
64+
## License
65+
66+
The Delphi CLI is open source and available under Apache 2 License.
67+
68+
[![GitHub license](https://img.shields.io/github/license/delphi-hub/delphi-cli.svg)](https://github.com/delphi-hub/delphi-cli/blob/master/LICENSE)

src/main/scala/de/upb/cs/swt/delphi/cli/Config.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ package de.upb.cs.swt.delphi.cli
66
* @param verbose Marker if logging should be verbose
77
* @param mode The command to be run
88
*/
9-
case class Config (server : String = sys.env.getOrElse("DELPHI_SERVER", ""), verbose: Boolean = false, mode : String = "") {
9+
case class Config (server : String = sys.env.getOrElse("DELPHI_SERVER", "https://delphi.cs.uni-paderborn.de/api/"), verbose: Boolean = false, mode : String = "") {
1010

1111
}

0 commit comments

Comments
 (0)