Skip to content
This repository has been archived by the owner on Nov 7, 2023. It is now read-only.

Commit

Permalink
update github docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dustin Blackman committed Nov 21, 2017
1 parent 3e5c605 commit 64b757b
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 10 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTE.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# Contribute

## Code
I'm more then open to pull requests! Make sure to check out my [Zenhub board](https://github.com/dustinblackman/Championify#boards?repos=34264106) so we don't have any conflicts if I or someone else has already started on an issue.

JSDocs for the majority of functions can be found [here](https://doclets.io/dustinblackman/Championify/master).
Pull requests are more then welcome! JSDocs for the majority of functions can be found [here](https://doclets.io/dustinblackman/Championify/master) to get an idea of the structure of the code base. I'm aware that the code base can be a tad confusing, there are decisions made that I wouldn't make today. When the time for a restructing comes, those will be fixed.

__Rules__

- Everything is in ES6 Javascript with the Node 6 presets. That means `const` and `let`, everything for example.
- New features must be discussed in an issue first before a PR, this prevents wasting anyones time incase it's already being worked on.
- Reframe from adding new npm modules if there's already something that'll get the job done.
- Reframe from adding new npm modules if there's already something that'll get the job done. E.g. don't add `lodash` as
`ramda` is already provided.
- Must pass all tests. `npm test`
- Must write tests for all new functions (look at current tests for examples, still a WIP).
- Functions must be camel cased. `downloadStuff()`
- Variables must be underscored. `my_champion = 'teemo'`
- PR must be off and back to master branch.
- Do not submit translation changes in a pull request, see [translations](#translations) below.

I suggest making sure your linters are setup correctly, or run `npm run lint` every now and again so you're not making a crazy amount of commits.

__Adding A Source__
__Adding a source__

You can find examples for adding sources in [src/sources](src/sources). Each source requires an object export of `source_info`, a function called `getSr()` for summoners rift item sets, and `getVerion()` for the current LoL patch version. Once finished, the app will automatically add the new source to sources list. Make sure to add a nice little 16x16 icon in the [app/img/sources](app/img/sources) folder. For an easy example check out [src/sources/koreanbuilds.js](src/sources/koreanbuilds.js).
You can find examples for adding sources in [src/sources](src/sources). Each source requires an object export of `source_info`, a function named `getSr()` for summoners rift item sets, and `getVerion()` for the current LoL patch version. Once finished, the app will automatically add the new source to sources list. Make sure to add a nice little 16x16 icon in the [app/img/sources](app/img/sources) folder. For an easy example check out [src/sources/koreanbuilds.js](src/sources/koreanbuilds.js).

---
## Translations

### Translations
I use [Transifex](https://www.transifex.com/dustinblackman/championify) to manage all my translations, it's super easy and lets everyone contribute! The initial translations were done with Google Translate, so just because a translation exists doesn't mean it's correct. You can also check out the language status list below to see which have been done by Google, and which has had attention from a native speaker.

__Rules__
Expand Down
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
_Please fill in the following when reporting an issue/bug and remove this line. Please include all logs, configs, and
screenshots if possible._

_Config and file locations:_
_- Log: C:/Users/YOURNAME/AppData/Roaming/Championify/championify.log.txt_
_- Config: C:/Users/YOURNAME/AppData/Roaming/Championify/prefs.json_

__What operating system:__
__What version of Championify:__
__Please explain the issue you're encountering:__
__Screenshots:__
__Logs:__

---

_Please fill in the following for feature requests:_

__Description of feature:__
__Mocks/screenshots of ideas:__
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
_Champion-If-Ayyy_

[![Donate](https://img.shields.io/badge/Donate-Patreon-5cb85c.svg)](https://patreon.com/dustinblackman)
[![Join the chat at https://gitter.im/dustinblackman/Championify](https://img.shields.io/badge/%E2%8A%AA%20GITTER%20-JOIN%20CHAT%20%E2%86%92-brightgreen.svg?style=flat)](https://gitter.im/dustinblackman/Championify?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![API Doc](https://doclets.io/dustinblackman/Championify/master.svg)](https://doclets.io/dustinblackman/Championify/master)
[![Travis](https://img.shields.io/travis/dustinblackman/Championify/master.svg)](https://travis-ci.org/dustinblackman/Championify/builds)
[![AppVeyor](https://ci.appveyor.com/api/projects/status/dt20uyoxt2skgneu/branch/master?svg=true)](https://ci.appveyor.com/project/dustinblackman/championify/branch/master)
Expand All @@ -32,7 +31,7 @@ There's also [Championify for Android](https://github.com/OmerValentine/Champion
- Summoners Rift and ARAM Item Sets
- 7 Sources (Champion.gg, LolFlavor, KoreanBuilds, op.gg, Lolalytics, Probuilds, and Lolmasters)
- Skill Priorities lists (Q.W.E.Q.E.R) or Q>E>W
- 39 Languages
- 41 Languages
- Bunch of preferences to display item sets in the way you prefer
- Automation using command line preferences (simpler system coming soon)
- Automatically save preference settings
Expand All @@ -49,7 +48,7 @@ Found [here](https://github.com/dustinblackman/Championify/releases/latest)
I'm completely open to new ideas and suggestions! Put up an [Issue](https://github.com/dustinblackman/Championify/issues), hit me up on [Gitter](https://gitter.im/dustinblackman/Championify), or send me a message on reddit [/u/dustinheroin](https://www.reddit.com/user/dustinheroin) and I'll see what I can do.

## Contribute
Please see [CONTRIBUTE.md](CONTRIBUTE.md)
Please see [CONTRIBUTING.md](./.github/CONTRIBUTING.md)

## [FAQ](FAQ.md)
See [FAQ.md](FAQ.md)
Expand Down

0 comments on commit 64b757b

Please sign in to comment.