Skip to content

Commit b2f8368

Browse files
hhslepickahhslepicka
authored
Merge pull request #2 from botcity-dev/new_readme
DOC: Updating readme, adding GitHub community docs and issue templates.
2 parents 06a8a8e + 37f3b0c commit b2f8368

File tree

5 files changed

+204
-2
lines changed

5 files changed

+204
-2
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributing
2+
3+
## Getting Started
4+
5+
* Make sure you have a [GitHub account](https://github.com/signup/free)
6+
* Submit a ticket for your issue, assuming one does not already exist.
7+
* Clearly describe the issue including steps to reproduce when it is a bug.
8+
* Make sure you fill in the earliest version that you know has the issue.
9+
* Fork the repository on GitHub
10+
11+
12+
## Making Changes
13+
14+
* Create a topic branch from where you want to base your work.
15+
* This is usually the master branch.
16+
* Only target release branches if you are certain your fix must be on that
17+
branch.
18+
* To quickly create a topic branch based on master; `git checkout -b
19+
fix/master/my_contribution master`. Please avoid working directly on the
20+
`master` branch.
21+
* Make commits of logical units.
22+
* Check for unnecessary whitespace with `git diff --check` before committing.
23+
* Make sure your commit messages are in the proper format (see below)
24+
* Make sure you have added the necessary tests for your changes.
25+
* Run _all_ the tests to assure nothing else was accidentally broken.
26+
27+
### Writing the commit message
28+
29+
Commit messages should be clear and follow a few basic rules. Example:
30+
31+
```
32+
ENH: add functionality X to framework.<submodule>.
33+
34+
The first line of the commit message starts with a capitalized acronym
35+
(options listed below) indicating what type of commit this is. Then a blank
36+
line, then more text if needed. Lines shouldn't be longer than 72
37+
characters. If the commit is related to a ticket, indicate that with
38+
"See #3456", "See ticket 3456", "Closes #3456" or similar.
39+
```
40+
41+
Describing the motivation for a change, the nature of a bug for bug fixes
42+
or some details on what an enhancement does are also good to include in a
43+
commit message. Messages should be understandable without looking at the code
44+
changes.
45+
46+
Standard acronyms to start the commit message with are:
47+
48+
49+
|Code| Description |
50+
|----|----------------------------------------------------|
51+
|API | an (incompatible) API change |
52+
|BLD | change related to building |
53+
|BUG | bug fix |
54+
|DEP | deprecate something, or remove a deprecated object |
55+
|DEV | development tool or utility |
56+
|DOC | documentation |
57+
|ENH | enhancement |
58+
|MNT | maintenance commit (refactoring, typos, etc.) |
59+
|REV | revert an earlier commit |
60+
|STY | style fix (whitespace, PEP8) |
61+
|TST | addition or modification of tests |
62+
|REL | related to releasing numpy |
63+
|WIP | Commit that is a work in progress |
64+
65+
## The Pull Request
66+
67+
* Now push to your fork
68+
* Submit a [pull request](https://help.github.com/articles/using-pull-requests) to this branch. This is a start to the conversation.
69+
70+
At this point you're waiting on us. We like to at least comment on pull requests within three business days
71+
(and, typically, one business day). We may suggest some changes or improvements or alternatives.
72+
73+
Hints to make the integration of your changes easy (and happen faster):
74+
- Keep your pull requests small
75+
- Don't forget your unit tests
76+
- All algorithms need documentation, don't forget the .rst file
77+
- Don't take changes requests to change your code personally

‎.github/ISSUE_TEMPLATE/bug-report.md‎

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: Let us know if something is broken.
4+
5+
---
6+
7+
**Describe the bug**
8+
<!-- A clear and concise description the bug -->
9+
10+
**Expected behavior**
11+
<!-- A clear and concise description of what you expected to happen -->
12+
13+
**Steps to Reproduce**
14+
<!-- Steps to reproduce the bug -->
15+
16+
**Possible Solution**
17+
<!--
18+
Not obligatory, but suggest a fix/reason for the bug, or ideas how to
19+
implement the addition or change.
20+
-->
21+
22+
**My Platform**
23+
<!--
24+
Any details about your specific platform:
25+
* OS Version
26+
* Python Version
27+
* Packages Version (One good start point is `pip list`.
28+
-->
29+
30+
**Additional context**
31+
<!-- Add any other context, links, etc. about the bug here. -->

‎.github/ISSUE_TEMPLATE/feature-request.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature.
4+
5+
---
6+
7+
**What's the problem this feature will solve?**
8+
<!-- A clear and concise description of what the problem is. -->
9+
10+
**Describe the solution you'd like**
11+
<!-- A clear and concise description of what you want to happen. -->
12+
13+
**Additional context**
14+
<!-- Add any other context, links, etc. about the feature here. -->

‎.github/SUPPORT.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### Getting Started
2+
3+
### Bug reports & Feature request
4+
5+
If you spot a problem, please let us know by following the template in
6+
here: [Report a bug](https://github.com/botcity-dev/botcity-framework-core-python/issues/new?template=bug-report.md).
7+
8+
Ideas or suggestions for enhancements are more than welcome. Please use the following
9+
template in here: [Request feature](https://github.com/botcity-dev/botcity-framework-core-python/issues/new?template=feature-request.md).
10+
11+
### Contact us
12+
13+
If you have questions of comments in general about the framework core we want to know.
14+
15+
You can choose between the channels open for communication the one that best fit you:
16+
17+
- [BotCity Community](<https://community.botcity.dev>) (Public)
18+
19+
or you can [file a bug](https://github.com/botcity-dev/botcity-framework-core-python/issues/new?template=bug-report.md) and let us know where our documentation could be improved.

‎README.md‎

Lines changed: 63 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,63 @@
1-
# botcity-python
2-
BotCity Framework - Python
1+
<p align="center">
2+
<h1 align="center">BotCity Framework Core - Python</h1>
3+
4+
<p align="center">
5+
<strong>« Explore Framework <a href="https://botcity-dev.github.io/botcity-framework-core-python/">docs</a> »</strong>
6+
<br>
7+
<br>
8+
<a href="https://github.com/botcity-dev/botcity-framework-core-python/issues/new?template=bug-report.md">Report bug</a>
9+
·
10+
<a href="https://github.com/botcity-dev/botcity-framework-core-python/issues/new?template=feature-request.md&labels=request">Request feature</a>
11+
·
12+
<a href="https://github.com/botcity-dev/botcity-framework-core-python/blob/main/.github/CONTRIBUTING.md">How to Contribute</a>
13+
·
14+
<a href="https://github.com/botcity-dev/botcity-framework-core-python/blob/main/.github/SUPPORT.md">Support</a>
15+
</p>
16+
</p>
17+
18+
<br>
19+
20+
# Prerequisites
21+
* Python 3.7+
22+
* pyautogui
23+
* keyboard
24+
* pyperclip
25+
* opencv
26+
27+
Python package requirements are listed in the requirements.txt file, which can
28+
be used to install all requirements from pip: 'pip install -r requirements.txt'
29+
30+
# Running the Tests
31+
In order to run the tests you will need to install some dependencies that are
32+
not part of the runtime dependencies.
33+
34+
Assuming that you have cloned this repository do:
35+
36+
```bash
37+
pip install -r test-requirements.txt
38+
39+
python run_tests.py
40+
```
41+
42+
# Running the Examples
43+
There are various examples of the features and how to get started.
44+
Check out the examples folder.
45+
46+
# Building the Documentation Locally
47+
In order to build the documentation you will need to install some dependencies
48+
that are not part of the runtime dependencies.
49+
50+
Assuming that you have cloned this repository do:
51+
52+
```bash
53+
pip install -r docs-requirements.txt
54+
55+
mkdocs build
56+
```
57+
58+
This will generate the HTML documentation in the `<>/site`
59+
folder. Look for the `index.html` file and open it with your browser.
60+
61+
# Online Documentation
62+
63+
Documentation is available at https://botcity-dev.github.io/botcity-framework-core-python.

0 commit comments

Comments
 (0)