Skip to content
This repository has been archived by the owner on Mar 29, 2023. It is now read-only.

Commit

Permalink
Initial project structure
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasmasuch committed Aug 7, 2019
1 parent 7411149 commit 9ea71e8
Show file tree
Hide file tree
Showing 13 changed files with 382 additions and 2 deletions.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!--
Please keep in mind that the GitHub issue tracker is mostly intended for bug reports, feature requests, deployment problems, or other enhancements.
For general usage questions, please consider posting on Stack Overflow or Gitter instead. You can find the links for all our support channels here: https://github.com/ml-tooling/lazycluster#support
-->

**Describe the issue:**

<!-- Describe your issue, but please be descriptive! Include screenshots, logs, code or other info to help explain your problem -->

**Technical details:**

- Library version <!-- run `import lazycluster; print(lazycluster.__version__)` -->:
- Python version<!-- run `import sys; print(sys.version)` on your machine -->:
- SSH version <!-- run `ssh -V` on your machine -->:
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: "\U0001F6A8 Bug report"
about: Did you come across a bug or unexpected behaviour differing from the docs?
title: ''
labels: bug
assignees: ''

---

<!--
Thanks for reporting a bug 🙌 ❤️
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
Also, be sure to check our documentation first: https://github.com/ml-tooling/lazycluster
-->

**Describe the bug:**

<!-- Describe your issue, but please be descriptive! Thanks again 🙌 ❤️ -->

**Expected behaviour:**

<!-- A clear and concise description of what you expected to happen. -->

**Steps to reproduce the issue:**

<!-- include screenshots, logs, code or other info to help explain your problem -->

<!--
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-->

**Technical details:**

- Library version <!-- run `import lazycluster; print(lazycluster.__version__)` -->:
- Python version<!-- run `import sys; print(sys.version)` on your machine -->:
- SSH version <!-- run `ssh -V` on your machine -->:

**Possible Fix:**

<!--- Not obligatory, but suggest a fix or reason for the bug -->

**Additional context:**

<!-- Add any other context about the problem here. -->
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/02_feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: "\U0001F381 Feature request"
about: Do you have an idea for an improvement or a new feature?
title: ''
labels: feature-request
assignees: ''

---

<!--
Thanks for requesting a feature 🙌 ❤️
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
-->

**Feature description:**

<!---
Provide a detailed description of the feature or improvement you are proposing. What specific solution would you like? What is the expected behaviour?
Add any other context, screenshots, or code snippets about the feature request here as well.
-->

**Problem and motivation:**

<!---
Why is this change important to you? What is the problem this feature would solve? How would you use it? How can it benefit other users?
-->

**Is this something you're interested in working on?**

<!--- Yes or No -->
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/03_documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: "\U0001F4DA Documentation"
about: Is there a mistake in the docs, is anything unclear or do you have a suggestion?
title: ''
labels: enhancement, docs
assignees: ''

---

**Describe your request:**

<!-- Describe the problem or suggestion here. If you've found a mistake and you know the answer, feel free to submit a pull request straight away: https://github.com/ml-tooling/lazycluster/pulls -->

**Which page or section is this issue related to?**

<!-- Please include the URL. -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/04_installation-problem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "\U0001F433 Installation Problem"
about: Do you have problems with installation, and none of the suggestions in the docs and other issues helped?
title: ''
labels: ''
assignees: ''

---

<!--
Thanks for reporting an issue with deployment 🙌 ❤️
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
-->

**Describe the issue:**

<!-- Describe your issue, but please be descriptive! Include screenshots, logs, code or other info to help explain your problem -->

**Technical details:**

- Library version <!-- run `import lazycluster; print(lazycluster.__version__)` -->:
- Python version<!-- run `import sys; print(sys.version)` on your machine -->:
- SSH version <!-- run `ssh -V` on your machine -->:
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/05_anything-else.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "\U0001F4AC Anything else?"
about: For general usage questions, please consider posting on Stack Overflow or Gitter instead.
title: ''
labels: ''
assignees: ''

---

<!--
Please keep in mind that the GitHub issue tracker is mostly intended for bug reports, feature requests, deployment problems, or other enhancements.
For general usage questions, please consider posting on Stack Overflow or Gitter instead. You can find the links for all our support channels here: https://github.com/ml-tooling/lazycluster#support
-->

**Describe the issue:**

<!-- Describe your issue, but please be descriptive! Include screenshots, logs, code or other info to help explain your problem -->

**Technical details:**

- Library version <!-- run `import lazycluster; print(lazycluster.__version__)` -->:
- Python version<!-- run `import sys; print(sys.version)` on your machine -->:
- SSH version <!-- run `ssh -V` on your machine -->:
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
Thank you for creating a pull request 🙌 ❤️
-->

**What kind of change does this PR introduce?**
<!-- (Update "[ ]" to "[x]" to check a box) -->

- [ ] Bugfix
- [ ] New Feature
- [ ] Feature Improvment
- [ ] Refactoring
- [ ] Documentation
- [ ] Other, please describe:

**Description:**
<!--- Use this section to describe your changes. Why is this change required? What problem does it solve? If your test fixes a specific issue, don't forget to reference the issue number. If your PR is still a work in progress, that's totally fine – just include a note to let us know. -->

**Checklist:**
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->

- [ ] I have read the [CONTRIBUTING](https://github.com/ml-tooling/lazycluster/blob/master/CONTRIBUTING.md) document.
- [ ] My changes don't require a change to the documentation, or if they do, I've added all required information.
3 changes: 3 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Support

Please refer to our [support](https://github.com/ml-tooling/lazycluster#support) and [contribution](https://github.com/ml-tooling/lazycluster#contribution) sections on our main README for more information.
52 changes: 52 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Platform Artifacts
environment/
logs/
*.log

# IntelliJ
target/
.idea/
*.iml

# Sublime
*.sublime-workspace

# Eclipse
.settings

# VS Code
.vscode
.project
.classpath

# Java
*.class
target/

# C
*.so

# Python
*.pyc
*.egg-info
__pycache__
.ipynb_checkpoints
.Python
dist/
build/
.python-version
.installed.cfg
*.egg

# Byte-compiled / optimized / DLL files
*.pyc
__pycache__/
*.py[cod]
*$py.class

# Other Artifacts
hs_err_pid*
*.log
*.swp
temp/*
.DS_Store
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TBD
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
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 project team at [email protected]. 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
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TBD
Loading

0 comments on commit 9ea71e8

Please sign in to comment.