No description
Find a file
Matteo Pagliazzi 0280513a00
improvements to apidocs comments (#11832)
* make corrections and improvements to apidocs (no code changes)

* make further minor tweaks to apidocs that were previously changed

* make one extra small change for consistency

* fix lines that are too long

Each line was fixed by one of these:
- changing the wording
- breaking into separate lines
- adding eslint-disable-line max-len (necessary for `@api ` lines because
a line break there causes the first part of the text to not be displayed
on the apidocs website)

* apply eslint-disable max-len around block comments that need to have a long line

The `@api ` lines can't have a line break in them because it would
cause the first part of the text to not be displayed on the apidocs
website.

Using `// eslint-disable-line max-len` at the end of an `@api `
line doesn't work, possibly because it's nesting a comment inside
a multi-line comment.

The only way I've found to ignore the `max-len` rule is to put
disable and enable comments around the whole comment block.
2020-02-24 21:22:29 +01:00
.ebextensions Old Client Cleanup (#9141) 2017-10-12 16:44:28 +02:00
.github Docs: Fixing small typos (#11454) 2019-11-01 19:01:15 +01:00
database_reports Scripts October 2018 (#10741) 2018-10-07 14:20:30 -05:00
gulp remove non-existent files and directories from nodemon config (#11451) 2019-10-20 11:03:54 +02:00
keys/google change Google iap-live for Android mobile app gem purchases, at negue's request 2015-12-03 06:22:59 +10:00
kubernetes Kubernetes support for dev environments (#8753) 2017-07-01 09:30:08 -07:00
migrations feat(content): Cotton Candy Pink Prizes 2020-02-17 11:37:37 -06:00
scripts Use new indexes in GDPR script (#11567) 2019-11-25 08:09:49 -06:00
test Resolves #11861 — Makes "quest already started" error descriptive (#11862) 2020-02-19 16:07:17 +01:00
website improvements to apidocs comments (#11832) 2020-02-24 21:22:29 +01:00
.babelrc fix babel and remove unused deps 2019-10-02 20:09:26 +02:00
.buildpacks refactor(tasks) improve UI consistency 2014-11-27 10:32:57 +00:00
.codeclimate.yml Only list javascript in .codeclimate.yml 2015-08-02 17:54:05 +02:00
.dockerignore 11498: fixed issues with Dockerfile-Dev (#11518) 2019-11-27 14:01:13 -06:00
.editorconfig Create .editorconfig 2016-09-07 08:44:57 -05:00
.eslintignore fix lint script 2019-10-13 18:35:33 +02:00
.eslintrc.js add eslint files 2019-10-08 22:57:22 +02:00
.gitignore PMs rebuild (#11360) 2020-01-12 19:34:40 +01:00
.nodemonignore remove non-existent files and directories from nodemon config (#11451) 2019-10-20 11:03:54 +02:00
.nvmrc Node 12 (#11149) 2019-08-19 22:43:17 +02:00
apidoc.json chore: Remove versioning from apidoc 2016-05-25 11:11:39 -05:00
config.json.example mongo: tweak the default connection size 2019-10-18 12:41:04 +02:00
docker-compose.dev.yml Fix issues with local Docker development. 2019-12-31 11:47:32 -05:00
docker-compose.yml docker: mongodb3.6 2019-10-18 16:52:21 +02:00
Dockerfile fix(build): more adjustments for Docker 2019-10-31 19:00:56 +00:00
Dockerfile-Dev Fix issues with local Docker development. 2019-12-31 11:47:32 -05:00
gulpfile.js misc, fix client tests 2019-10-15 15:32:53 +02:00
LICENSE Fix grammar mistakes in license file 2016-06-21 06:42:20 -05:00
package-lock.json build(deps-dev): bump sinon-chai from 3.4.0 to 3.5.0 (#11895) 2020-02-24 14:28:53 +01:00
package.json build(deps-dev): bump sinon-chai from 3.4.0 to 3.5.0 (#11895) 2020-02-24 14:28:53 +01:00
Procfile API v3 [WIP] (#6144) 2016-05-23 13:58:31 +02:00
README.md Enable Github Actions in place of Travis (#11447) 2019-10-19 17:32:14 +02:00

Habitica Build Status Code Climate Bountysource Open Source Helpers

Greenkeeper badge

Habitica is an open source habit building program which treats your life like a Role Playing Game. Level up as you succeed, lose HP as you fail, earn money to buy weapons and armor.

We need more programmers! Your assistance will be greatly appreciated. The wiki pages below and the additional pages they link to will tell you how to get started on contributing code and where you can go to seek further help or ask questions:

Habitica's code is licensed as described at https://github.com/HabitRPG/habitica/blob/develop/LICENSE

Found a bug? Please report it in the Report a Bug guild rather than creating an issue (an admin will advise you if a new issue is necessary; usually it is not).

Have any questions about Habitica or its community? See the links in the habitica.com website's Help menu or drop in to Guilds > Tavern Chat to ask questions or chat socially!