diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 485a3a9..6db61f0 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,17 +2,17 @@ ## Guidelines -Contributions, wheither it is code, bug reporting, or documentation, is always welcome. Just fork, code, commit, and pull request! +Contributions, whether it is code, bug reporting, or documentation, is always welcome. Just fork, code, commit, and pull request! For coding standards, we use ESLint and Prettier to ensure everything is good. While not required in your editor of choice, using ESLint while developing is highly recommended as Prettier will prevent any commit if it fails to fix/meet with the current code standards. For naming conventions, please stick with camelCase for general purposes and PascalCase for enums and constants. ## Reporting Bugs and Issues -Bug reports are handled through the issue tracker on the [GitHub repository](https://github.com/Butterstroke/AniList-Node/issues/new/choose). +Bug reports are handled through the issue tracker on the [GitHub repository](https://github.com/AurelicButter/AniList-Node/issues/new/choose). For bugs and issues, please use the bug report template and fill out as much useful information as possible. This includes but is not limited to: error messages, screenshots of unexpected outputs, and Node.js/package versions in use. -For questions and support needs, there is a questions template avalible. +For questions and support needs, there is a questions template available. ## Developing the Package @@ -24,9 +24,9 @@ For questions and support needs, there is a questions template avalible. * There is no automated testing, you will have to verify your edits manually before making a PR. * You can create a testing file in `/tests` if your changes cannot be tested with the current files. Otherwise, please use the provided testing files 5. Ensure your code is documented with [JSDoc3](https://jsdoc.app) in the comments - * The documentation is auto-generated from these comments. So make sure they are clear and consise. - * Documentiation files in `/docs` directory do not need to be updated in your changes as they are updated before every release. -6. Commit your changes and submit a [Pull Request](https://github.com/Butterstroke/AniList-Node/pulls). + * The documentation is auto-generated from these comments. So make sure they are clear and concise. + * Documentation files in `/docs` directory do not need to be updated in your changes as they are updated before every release. +6. Commit your changes and submit a [Pull Request](https://github.com/AurelicButter/AniList-Node/pulls). ## Pull Requests @@ -39,5 +39,5 @@ Any pull requests with the following is accepted after review... Pull requests that just consist of the following will be not accepted... * Minor spelling mistakes or word changes -* Dependancy Updates +* Dependency Updates * Re-generated Documentation Files \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c94b129..317e443 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,7 +3,7 @@ name: Bug report about: For users looking to report a bug or an issue title: '' labels: Bug -assignees: Butterstroke +assignees: AurelicButter --- diff --git a/.github/ISSUE_TEMPLATE/questions.md b/.github/ISSUE_TEMPLATE/questions.md index a1a0b82..0488074 100644 --- a/.github/ISSUE_TEMPLATE/questions.md +++ b/.github/ISSUE_TEMPLATE/questions.md @@ -3,7 +3,7 @@ name: Questions about: For users looking for more information about something title: '' labels: Question -assignees: Butterstroke +assignees: AurelicButter --- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7b3e9b9..6c075ed 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,7 @@ ## Description diff --git a/README.md b/README.md index 6db0935..07face9 100644 --- a/README.md +++ b/README.md @@ -37,13 +37,13 @@ Anilist.media.anime(21708).then(data => { For a more in-depth guide on getting started, check out our [Getting Started](https://katsurin.com/docs/anilist-node/tutorial-Getting%20Started.html) guide on our site or on the static HTML site under the docs directory. ## Documentation -Documentation is provided in two locations. A static HTML site is avalible with the package under the docs directory. Or users can view the same site online here: [katsurin.com/docs/anilist-node](https://www.katsurin.com/docs/anilist-node/index.html). +Documentation is provided in two locations. A static HTML site is available with the package under the docs directory. Or users can view the same site online here: [katsurin.com/docs/anilist-node](https://www.katsurin.com/docs/anilist-node/index.html). ## Contributing -Please refer to the [Contributing Guide](https://github.com/Butterstroke/AniList-Node/tree/master/.github/CONTRIBUTING.md) for more information. +Please refer to the [Contributing Guide](https://github.com/AurelicButter/AniList-Node/tree/master/.github/CONTRIBUTING.md) for more information. ## License and Contact AniList-Node is licensed under the [MIT License](LICENSE). -For issues and bugs, please use the issue tracker on the [GitHub repository](https://github.com/Butterstroke/AniList-Node/issues). For other needs, either contact me by email [fkatsura@katsurin.com](mailto:fkatsura@katsurin.com) or in my [Discord server](https://discord.gg/qKfqsjW) in the #anilist-node channel. +For issues and bugs, please use the issue tracker on the [GitHub repository](https://github.com/AurelicButter/AniList-Node/issues). For other needs, either contact me by email [fkatsura@katsurin.com](mailto:fkatsura@katsurin.com) or in my [Discord server](https://discord.gg/qKfqsjW) in the #anilist-node channel. diff --git a/docs/AniList.Activity.html b/docs/AniList.Activity.html index 3205237..5af6411 100644 --- a/docs/AniList.Activity.html +++ b/docs/AniList.Activity.html @@ -1,4 +1,4 @@ - +
@@ -37,7 +37,7 @@date
date
date
date
date
date
date
endDate
startDate
Name | + +Type | + +Description | +
---|---|---|
year |
+
+ + Number + | + + null + | + ++ |
month |
+
+ + Number + | + + null + | + ++ |
day |
+
+ + Number + | + + null + | + ++ |
startDate
Name | - -Type | - -Description | -
---|---|---|
year |
-
- - Number - | - -- |
month |
-
- - Number - | - -- |
day |
-
- - Number - | - -- |
endDate
Name | - -Type | - -Description | -
---|---|---|
year |
-
- - Number - | - -- |
month |
-
- - Number - | - -- |
day |
-
- - Number - | - -- |
endDate
startDate
- Documentation is provided in two locations. A static HTML site is avalible with the package + Documentation is provided in two locations. A static HTML site is available with the package under the docs directory. Or users can view the same site online here: katsurin.com/docs/anilist-nodeDocumentation
Please refer to the - Contributing Guide for more information. @@ -313,7 +314,7 @@
AniList-Node is licensed under the MIT License.
For issues and bugs, please use the issue tracker on the - GitHub repository. For other + GitHub repository. For other needs, either contact me by email fkatsura@katsurin.com or in my Discord server in the #anilist-node channel. diff --git a/docs/index.js.html b/docs/index.js.html index 1a9c7fc..4d82bf3 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -1,4 +1,4 @@ - +
@@ -37,7 +37,7 @@