-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from delphi-hub/develop
Updated project infrastructure
- Loading branch information
Showing
6 changed files
with
193 additions
and
1 deletion.
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,38 @@ | ||
--- | ||
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. | ||
|
||
**Affected components (if known)** | ||
Choose those applicable here: crawler, cli, webapi, webapp, management | ||
|
||
**Desktop (please complete the following information, if relevant):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information, if relevant):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**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,18 @@ | ||
--- | ||
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. | ||
Just using "none" is okay here. | ||
|
||
**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,46 @@ | ||
# 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, gender identity and expression, level of experience, 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 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. | ||
|
||
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 [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
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,22 @@ | ||
# Contribution Guide | ||
|
||
We follow the GitHub [Fork & Pull][forkandpull] and [Git Flow][gitflow] workflow in this project. | ||
Please fork the official repository, develop in a branch based on the | ||
current develop branch, and submit a pull request (PR) after you are done. | ||
|
||
[forkandpull]: https://help.github.com/articles/about-pull-requests/ | ||
[gitflow]: http://nvie.com/posts/a-successful-git-branching-model/ | ||
|
||
## Checklist before submitting a Pull Request | ||
|
||
Before you submit your PR, please go through this list and check if | ||
your request fulfills these points. | ||
|
||
- Do you have more changes/additions/deletions in your PR than you expected? | ||
- Do you have tests for your changes? | ||
- Do all tests of the project succeed? | ||
- Is your pull request based on the `develop` branch? [(cf. GitFlow)][gitflow] | ||
|
||
If you check these items before, your pull request is more likely to be | ||
included into the project quickly. | ||
|
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,68 @@ | ||
# Delphi Command-Line Interface (CLI) | ||
|
||
The command-line interface for the Delphi platform. | ||
|
||
We are currently in pre-alpha state! There is no release and the code in | ||
this repository is purely experimental! | ||
|
||
|branch | status | codacy | | ||
| :---: | :---: | :---: | | ||
| 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)| | ||
| develop | [![Build Status](https://travis-ci.org/delphi-hub/delphi-cli.svg?branch=develop)](https://travis-ci.org/delphi-hub/delphi-cli) | | | ||
|
||
## What is the Delphi Command-Line Interface? | ||
|
||
The Delphi CLI is a tool to access the data on the Delphi platform. | ||
It enables you to search for items matching a query or to inspect a dataset for an item in detail. | ||
It can be used in an automated context to automatically construct fitting item sets. | ||
|
||
## How does it work? | ||
|
||
The Delphi CLI checks the provided query and passes it on to the web API of the configured platform. | ||
The results are printed to the console by default. | ||
|
||
## How can I use it? | ||
|
||
The Delphi CLI is running on the Java Virtual Machine. | ||
We require a Java Runtime Environment (JRE) in version 8 or newer. | ||
|
||
Our software is available as a binary release on [GitHub](https://github.com/delphi-hub/delphi-cli/releases). | ||
|
||
``` | ||
$ delphi-cli --help | ||
Delphi Command Line Tool (1.0.0-SNAPSHOT) | ||
Usage: delphi-cli [test|search|retrieve] [options] | ||
--version Prints the version of the command line tool. | ||
--help Prints this help text. | ||
--server <value> The url to the Delphi server | ||
``` | ||
By default the command-line tool uses the official Delphi server at https://delphi.cs.uni-paderborn.de to process queries. | ||
You can override this setting using the `--server` option or by setting the `DELPHI_SERVER` environment variable. | ||
|
||
## Community | ||
|
||
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) | ||
|
||
|
||
## Contributing | ||
|
||
Contributions are *very* welcome! | ||
|
||
Before contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
||
Refer to the [Contribution Guide](CONTRIBUTING.md) for details about the workflow. | ||
We use Pull Requests to collect contributions. Especially look out for "help wanted" issues | ||
[![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), | ||
but feel free to work on other issues as well. | ||
You can ask for clarification in the issues directly, or use our Gitter | ||
chat for a more interactive experience. | ||
|
||
[![GitHub issues](https://img.shields.io/github/issues/delphi-hub/delphi-cli.svg)](https://github.com/delphi-hub/delphi-cli/issues) | ||
|
||
|
||
## License | ||
|
||
The Delphi CLI is open source and available under Apache 2 License. | ||
|
||
[![GitHub license](https://img.shields.io/github/license/delphi-hub/delphi-cli.svg)](https://github.com/delphi-hub/delphi-cli/blob/master/LICENSE) |
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