Skip to content

Commit 7c51f8e

Browse files
Merge pull request #1 from riibeirogabriel/migrating-python-client
Migrating python client
2 parents 52e2e6c + 6716227 commit 7c51f8e

File tree

10 files changed

+1666
-2
lines changed

10 files changed

+1666
-2
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Give a title explaining the bug/issue -->
11+
#### Bug description
12+
<!-- Describe the issue that you are having -->
13+
14+
#### Expected result
15+
<!-- What should be the expected result? -->
16+
17+
#### Actual result
18+
<!-- What is the result now? -->
19+
20+
#### Steps to reproduce
21+
<!-- If applicable -->
22+
23+
1.
24+
2.
25+
3.
26+
#### Context
27+
<!--- How has this issue affected you? What are you trying to accomplish? -->
28+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
29+
30+
#### Your Environment
31+
<!--- Include as many relevant details about the environment you experienced the bug in -->
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
#### Is your feature request related to a problem? Please describe.
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
#### Describe the solution you'd like
14+
A clear and concise description of what you want to happen.
15+
16+
#### Describe alternatives you've considered
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
#### Additional context
20+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#### Changes
2+
<!-- Please include a summary of the change and which issue is fixed. -->
3+
<!-- Please also include relevant motivation and context. -->
4+
<!-- List any dependencies that are required for this change. -->
5+
6+
Fixes # (issue)
7+
8+
#### Type of change
9+
<!-- Please delete options that are not relevant. -->
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
#### Checklist
17+
18+
- [ ] My code follows the style guidelines of this project
19+
- [ ] I have performed a self-review of my own code
20+
- [ ] I have commented my code, particularly in hard-to-understand areas
21+
- [ ] I have made corresponding changes to the documentation
22+
- [ ] My changes generate no new warnings

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to LearningOrchestra
2+
We want to make contributing to LearningOrchestra as easy and as simple as humanly possible.\
3+
Whether you want to:
4+
* Report an issue
5+
* Contribute with a feature
6+
* Contribute with a fix
7+
8+
Before you open an issue or a pull request, check whether that issue has been discussed already or a PR exists that addresses it. Don't open pull requests for issues that are already under review.
9+
10+
After looking through the issues and seeing that an issue is available for you to tackle, you may begin the pull request process.
11+
12+
### Reporting a bug/issue
13+
When creating an issue for a bug or other undefined/unwanted behaviour remember to include in your issue or pull request steps necessary to reproduce that behaviour.
14+
15+
## Pull Request process
16+
17+
1. [Fork](https://github.com/riibeirogabriel/learningOrchestra/fork) the repository
18+
2. [Clone](https://git-scm.com/docs/git-clone) your fork to your local environment
19+
3. Navigate into the project root directory
20+
4. Create a new [branch](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging), the branch should be named according to what feature/fix you're implementing
21+
5. Make your changes, stage them and [commit](https://git-scm.com/docs/git-commit) them to the branch
22+
- Make sure to use proper language idioms, formatting and linting before commiting your work, like proper variable naming, indentation, etc.
23+
- Make sure your code passes any tests the repository offers
24+
- Make sure to adopt the coding style of the repository and not to force your own coding habits into the codebase
25+
6. [Push](https://git-scm.com/docs/git-push) the changes to your fork
26+
7. Create a Pull Request
27+
28+
Remember to describe what feature or fix you're implementing in the Pull Request window.
29+
In the Pull Request window remember to include a quick summary of what the committed code does and how it is an improvement.
30+
31+
After the Pull Request the repository owner will review your request.\
32+
Be patient, if they require you to make changes to your request, do so.
33+
34+
## Standards
35+
Please be polite to other members and contributors and follow GitHub etiquette.\
36+
Don't be rude, use crude language or harass other users.
37+
38+
## License
39+
The repository is currently licenses under GNU General Public License v3.0.
40+
By contributing to the project you agree that your contributions will be licensed under the same license and provisions.

0 commit comments

Comments
 (0)