-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update readme and contributing
- Loading branch information
Showing
2 changed files
with
26 additions
and
148 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,34 @@ | ||
| # Contributing to Theme Tool | ||
| # Contributing Code | ||
|
|
||
| Thank you for your interest in participating! | ||
|
|
||
| There are many ways to contribute, beyond writing code or programming, by: logging bugs, reporting issues, and creating suggestions. To do so, please [create a ticket](https://github.com/shabados/theme-tool/issues/new/choose) in our issue tracker. See other ways to [Contribute](README.md#Contributing) or give [Feedback](README.md#Feedback). | ||
| There are many ways to contribute, beyond writing code or programming, by: asking questions, reporting bugs, and suggesting features. To do so, please log a [new issue](https://github.com/shabados/theme-tool/issues/new). | ||
|
|
||
| This document is for developers or programmers contributing to the source code of Theme Tool. | ||
| **This document is for developers or programmers contributing to the source code.** | ||
|
|
||
| **Table of Contents** | ||
| ## Get Started | ||
|
|
||
| - [Getting Started](#getting-started) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Build](#build) | ||
| - [Start](#start) | ||
| - [Workflow](#workflow) | ||
| - [Coding Guidelines](#coding-guidelines) | ||
| - [Scope](#scope) | ||
| - [Thank you](#thank-you) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| If you wish to better understand how `theme-tool` works or want to debug an issue: get the source, build it, and run it locally. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| In order to download necessary tools, clone the repository, and install dependencies, you'll need network access. | ||
|
|
||
| You'll need the following: | ||
| **Prerequisites** | ||
|
|
||
| - [Git](https://git-scm.com/) | ||
| - [Node.JS](https://nodejs.org) (If you need to manage multiple Node.JS versions, [use a node version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) to install) | ||
| - [Node.JS](https://nodejs.org) | ||
|
|
||
| **Development** | ||
|
|
||
| Get the source code of `theme-tool` repo: | ||
| Get the source code of `theme-tool` repo. Our recommended approach is to use the [`gh` cli tool from GitHub](https://cli.github.com/). This will fork the repo to your GitHub account (if not already), clone it to your local machine, and set the appropriate remotes for origin and upstream with the above command. | ||
|
|
||
| ```shell | ||
| gh repo fork shabados/theme-tool --clone=true | ||
| ``` | ||
|
|
||
| **PROTIP**: Use the [`gh` cli tool from GitHub](https://cli.github.com/) to fork the repo to your GitHub account (if not already), clone it to your local machine, and set the appropriate remotes for origin and upstream with the above command. | ||
|
|
||
| ### Build | ||
|
|
||
| Run `npm i` in the root directory. | ||
|
|
||
| ### Start | ||
|
|
||
| ```shell | ||
| npm start | ||
| ``` | ||
|
|
||
| This will launch Theme Tool on [port `3000`](https://localhost:3000). | ||
|
|
||
| ## Workflow | ||
|
|
||
| The workflow of development (or Git Flow) is to [choose/create an issue](https://github.com/shabados/theme-tool/issues) to work on, [create a feature branch](https://github.com/shabados/.github/wiki/How-to-Contribute#branches), and [submit a pull request](https://github.com/shabados/.github/wiki/How-to-Contribute#pull-requests). | ||
|
|
||
| **PROTIP**: Read more about our workflow (issue tracking, branching, and pull requests) in the [How To Contribute wiki article](https://github.com/shabados/.github/wiki/How-to-Contribute). | ||
|
|
||
| ### Coding Guidelines | ||
|
|
||
| Please see the [wiki](https://github.com/shabados/.github/wiki/How-to-Contribute#coding-guidelines) for Coding Guidelines ([Names](https://github.com/shabados/.github/wiki/How-to-Contribute#41-names), [Comments](https://github.com/shabados/.github/wiki/How-to-Contribute#42-comments), [Style](https://github.com/shabados/.github/wiki/How-to-Contribute#43-style), [Linting](https://github.com/shabados/.github/wiki/How-to-Contribute#44-linting), and [Commit Messages](https://github.com/shabados/.github/wiki/How-to-Contribute#45-commit-messages)). | ||
| Use `npm start` to launch Theme Tool on [port `3000`](https://localhost:3000). | ||
|
|
||
| ### Scope | ||
|
|
||
| To be used in [commit messages](https://github.com/shabados/.github/wiki/How-to-Contribute#45-commit-messages). | ||
|
|
||
| Usage: | ||
|
|
||
| ```shell | ||
| <type>(<scope>): <subject> | ||
| ``` | ||
| ## Contributing | ||
|
|
||
| There are no scopes for this repo. | ||
| Please see our organization docs on [contributing](https://docs.shabados.com/community/). These cover important aspects including workflow (how to submit a PR), coding guidelines (how to write a commit message), and project management (latest/next release information). | ||
|
|
||
| ## Thank you | ||
|
|
||
| Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to participate in this project. | ||
| Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to participate in this project! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters