Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@mertyildiran
mertyildiran committed Oct 29, 2017
1 parent 6ecdd75 commit 14613d9
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 22 deletions.
31 changes: 11 additions & 20 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ We have an official [chat room on Gitter](https://gitter.im/DragonComputer/Lobby
| | |
|-------------------------|-----------------------------------|
| **Operating systems** | Linux |
| **Python versions** | CPython 2.7. Only 64 bit. |
| **Python versions** | CPython 2.7, 3.6 (64-bit) |
| **Distros** | KDE neon, elementary OS, Ubuntu |
| **Package managers** | APT, pip |
| **Languages** | English |
Expand Down Expand Up @@ -110,33 +110,24 @@ Checking connectivity... done.

### Install Dragonfire in Development Mode

You need to install Dragonfire with `sudo` rights, even if you are installing editable/development mode because there is a post-installation script needs `sudo` rights.
You need to install Dragonfire with `sudo` rights, even if you are installing editable/development mode because there is a [post-installation script](https://github.com/DragonComputer/Dragonfire/blob/master/debian/postinst) that needs `sudo` rights.

```Shell
git clone https://github.com/YOUR-USERNAME/Dragonfire.git
cd Dragonfire/
sudo pip install -e .
chmod +x install-dev.sh
sudo ./install-dev.sh
```

alternatively you can install it with:

```
sudo pip install -Uve .
```

which means: `-U` (upgrade), `-v` (verbose), `-e` (editable/development mode)

Post-installation script consists of the [these lines](https://github.com/DragonComputer/Dragonfire/blob/master/setup.py#L19-L51). It's important to know it for troubleshooting installation problems.

#### Use It

Try to experience every command listed in [README.md](https://github.com/DragonComputer/Dragonfire#built-in-commands). Please watch [this playlist](https://www.youtube.com/playlist?list=PLwnH1TEQvAWddw8iTwCJ333fwygL2-tWD) if you do not understand how to use Dragonfire.
Try to experience every command listed in [README.md](https://github.com/DragonComputer/Dragonfire#built-in-commands). Please watch [this playlist](https://www.youtube.com/playlist?list=PLwnH1TEQvAWddw8iTwCJ333fwygL2-tWD) if you did not understand how to use Dragonfire.

If you face with a problem while installing or using Dragonfire then please take a look to the [Troubleshooting](#troubleshooting) section for cases that fitting to you situation. Our [chat room on Gitter](https://gitter.im/DragonComputer/Lobby) is also a viable option for support requests.
If you face with a problem while installing or using Dragonfire then please take a look at the [Troubleshooting](https://github.com/DragonComputer/Dragonfire/blob/master/docs/TROUBLESHOOTING.md#troubleshooting) section for the cases that fitting to your situation. Our [chat room on Gitter](https://gitter.im/DragonComputer/Lobby) is also a viable option for support requests.

#### Missing Software Packages (Optional)

There could be missing software packages on your system like **blender**, **gimp**, **inkscape**, **kdenlive**, etc. So Dragonfire will be unable to open them. If you want to use commands like `PHOTO EDITOR`, `INKSCAPE` install the necessary software on your system. You can see the list of built-in commands [here](https://github.com/DragonComputer/Dragonfire/blob/master/dragonfire/__init__.py#L80-L395).
There could be missing software packages on your system like **blender**, **gimp**, **inkscape**, **kdenlive**, etc. So Dragonfire will be unable to open them. If you want to use the commands like `PHOTO EDITOR`, `INKSCAPE` install the necessary software to your system. You can see the list of built-in commands [here](https://github.com/DragonComputer/Dragonfire/blob/78adeedf7a278bcb26786130c0c6dd46d914fc95/dragonfire/__init__.py#L126-L463).

#### Choice for Code Editor

Expand All @@ -153,15 +144,15 @@ If you are wondering about the package structure and distribution then please ta

#### Reporting Bugs

If you think you found a bug in Dragonfire then frist please check the all cases listed in [Troubleshooting](#troubleshooting) section. If you still think that's a bug then please [file an issue](https://github.com/DragonComputer/Dragonfire/issues/new) immediately. Don't forget to mention that it's a bug or something going on very wrong.
If you think you found a bug in Dragonfire then frist please check the all cases listed in [Troubleshooting](https://github.com/DragonComputer/Dragonfire/blob/master/docs/TROUBLESHOOTING.md#troubleshooting) section. If you still think that's a bug then please [file an issue](https://github.com/DragonComputer/Dragonfire/issues/new) immediately. Don't forget to mention that it's a bug or something going on very wrong.

<!-- This section guides you through submitting a bug report for Dragonfire. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:. -->

> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
#### Suggesting Enhancements

If you have a enhancement idea or you are not happy with an ugly piece of code then please [file an issue](https://github.com/DragonComputer/Dragonfire/issues/new) and mention that it's an enhancement proposal.
If you have an enhancement idea or you are not happy with an ugly piece of code then please [file an issue](https://github.com/DragonComputer/Dragonfire/issues/new) and mention that it's an enhancement proposal.

<!-- This section guides you through submitting an enhancement suggestion for Dragonfire, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:. -->

Expand Down Expand Up @@ -205,7 +196,7 @@ git pull origin master

At this step you are free to make any changes inside the local clone of your fork. Make sure that your changes serve to **single well defined goal** which will be your commit message. **DO NOT** try to achieve multiple (and unrelated) tasks with a single commit.

Before proceeding to Step 4, make sure that you have done all tests and you did not break any existing feature of Dragonfire.
Before proceeding to Step 4, make sure that you have done all the tests and you did not break any existing feature of Dragonfire.

#### Step 4: Push To Your Fork

Expand Down Expand Up @@ -280,4 +271,4 @@ cd Dragonfire/
dpkg-buildpackage -us -uc
```

It will save the `.deb` file into parent directory. `debian` directory is the directory contains all the configuration files and pre/post installation scripts related to Debian packaging.
It will save the `.deb` file into parent directory. `debian/` directory is the directory contains all the configuration files and pre/post-installation scripts related to Debian packaging.
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Dragonfire

<img src="https://travis-ci.org/DragonComputer/Dragonfire.svg?branch=master" align="right" />

Dragonfire is an open source virtual assistant project for Ubuntu based Linux distributions.

![Dragonfire](https://raw.githubusercontent.com/DragonComputer/Dragonfire/master/docs/img/demo.gif)
Expand All @@ -25,7 +27,7 @@ Feel free to join [our Gitter chat room](https://gitter.im/DragonComputer/Lobby)
| | |
|-------------------------|-----------------------------------|
| **Operating systems** | Linux |
| **Python versions** | CPython 2.7. Only 64 bit. |
| **Python versions** | CPython 2.7, 3.6 (64-bit) |
| **Distros** | KDE neon, elementary OS, Ubuntu |
| **Package managers** | APT, pip |
| **Languages** | English |
Expand Down
2 changes: 1 addition & 1 deletion README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Supported Environments
+---------------------------+-----------------------------------+
| **Operating systems** | Linux |
+---------------------------+-----------------------------------+
| **Python versions** | CPython 2.7. Only 64 bit. |
| **Python versions** | CPython 2.7, 3.6 (64-bit) |
+---------------------------+-----------------------------------+
| **Distros** | KDE neon, elementary OS, Ubuntu |
+---------------------------+-----------------------------------+
Expand Down

0 comments on commit 14613d9

Please sign in to comment.