diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43687fe..c717c9f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,27 +1,31 @@ # Contributing to Dext -♥ ***Dext*** and want to contribute? I am seeking contributors of any levels to help grow the application. You can help contribute to the growth of this application in many ways. +♥ **_Dext_** and want to contribute? I am seeking contributors of any levels to help grow the application. You can help contribute to the growth of this application in many ways. -- UI/UX design -- DX design -- Core plugins -- Third-party plugins -- Feedbacks, and suggestions +* UI/UX design +* DX design +* Core plugins +* Third-party plugins +* Feedbacks, and suggestions **Dext** is still in its very early stage of development and lots of new features and improvements will be added over time. -1. [Fork](https://help.github.com/articles/fork-a-repo/) and [clone](https://help.github.com/articles/cloning-a-repository/) this repository. +1. [Fork](https://help.github.com/articles/fork-a-repo/) and [clone](https://help.github.com/articles/cloning-a-repository/) this repository. - ```bash - $ git clone git@github.com:vutran/dext-core-utils.git - ``` -2. Switch to the new `dext-core-utils` directory that was created in step 1. +```bash +$ git clone git@github.com:vutran/dext-core-utils.git +``` + +2. Switch to the new `dext-core-utils` directory that was created in step 1. + + +```bash +$ cd dext-core-utils +``` + +3. Install dependencies. - ```bash - $ cd dext-core-utils - ``` - 3. Install dependencies. **With `npm`:** @@ -35,25 +39,26 @@ $ yarn ``` -4. Boot up the application. +4. Boot up the application. + - ```bash - $ npm start - ``` +```bash +$ npm start +``` -5. Submit a [Pull Request](https://github.com/vutran/dext-core-utils/pulls) to the `develop` branch if you have something great to contribute and a review will proceed. +5. Submit a [Pull Request](https://github.com/DextApp/dext-core-utils/pulls) to the `develop` branch if you have something great to contribute and a review will proceed. ## Bug Reports -Found a bug? Submit it to the [issue tracker](https://github.com/vutran/dext-core-utils/issues) and/or send a [Pull Request](#pull-requests) so we can get it squashed. +Found a bug? Submit it to the [issue tracker](https://github.com/DextApp/dext-core-utils/issues) and/or send a [Pull Request](#pull-requests) so we can get it squashed. ## Feature Requests -If you have an idea for a feature, please post them to the [issues tracker](https://github.com/vutran/dext-core-utils/issues) and we can discuss. Not all features will be implemented. +If you have an idea for a feature, please post them to the [issues tracker](https://github.com/DextApp/dext-core-utils/issues) and we can discuss. Not all features will be implemented. ## Pull Requests -As ***Dext*** grows into a more mature application, we want to make sure we only accept PR's that would allow the application to become better. If you have an idea and don't know if it will get accepted, please file an issue and we can discuss whether it could be merged into core or as a third-party plugin. +As **_Dext_** grows into a more mature application, we want to make sure we only accept PR's that would allow the application to become better. If you have an idea and don't know if it will get accepted, please file an issue and we can discuss whether it could be merged into core or as a third-party plugin. ## Feedback and Suggestions diff --git a/README.md b/README.md index 0c647db..2b09861 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Travis](https://img.shields.io/travis/vutran/dext-core-utils/develop.svg?maxAge=2592000&style=flat-square)](https://travis-ci.org/vutran/dext-core-utils) [![Coveralls branch](https://img.shields.io/coveralls/vutran/dext-core-utils/develop.svg?maxAge=2592000&style=flat-square)](https://coveralls.io/github/vutran/dext-core-utils) [![license](https://img.shields.io/github/license/vutran/dext-core-utils.svg?maxAge=2592000&style=flat-square)](LICENSE) [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/dext-app/Lobby) -> Utility modules shared between [Dext](https://github.com/vutran/dext) and [Dext Package Manager](https://github.com/vutran/dext-cli). +> Utility modules shared between [Dext](https://github.com/DextApp/dext) and [Dext Package Manager](https://github.com/DextApp/dext-cli). ## Install @@ -20,17 +20,17 @@ $ yarn add dext-core-utils ## Contributing -♥ ***Dext*** and want to contribute? I am seeking contributors of any levels to help grow the application. You can help contribute to the growth of this application in many ways. +♥ **_Dext_** and want to contribute? I am seeking contributors of any levels to help grow the application. You can help contribute to the growth of this application in many ways. -- [Bug Reports](CONTRIBUTING.md#bug-reports) -- [Feature Requests](CONTRIBUTING.md#feature-requests) -- [Pull Requests](CONTRIBUTING.md#pull-requests) -- [Feedback and Suggestions](CONTRIBUTING.md#feedback-and-suggestions) +* [Bug Reports](CONTRIBUTING.md#bug-reports) +* [Feature Requests](CONTRIBUTING.md#feature-requests) +* [Pull Requests](CONTRIBUTING.md#pull-requests) +* [Feedback and Suggestions](CONTRIBUTING.md#feedback-and-suggestions) ## Related -- [dext](https://github.com/vutran/dext) - The Dext smart launcher -- [dext-cli](https://github.com/vutran/dext-cli) - Dext Package Manager +* [dext](https://github.com/DextApp/dext) - The Dext smart launcher +* [dext-cli](https://github.com/DextApp/dext-cli) - Dext Package Manager ## License