Add maintainers guide #272
Conversation
Codecov Report
@@ Coverage Diff @@
## master #272 +/- ##
=======================================
Coverage 59.95% 59.95%
=======================================
Files 7 7
Lines 492 492
Branches 136 136
=======================================
Hits 295 295
Misses 169 169
Partials 28 28Continue to review full report at Codecov.
|
|
|
||
| ### Testing | ||
|
|
||
| This package has unit tests for most files in the same directory the code is in with the suffix `.spec` (i.e. `exampleFile.spec.ts`). You can run the entire test suite using the npm script `npm test`. This command is also executed by Travis, the continuous integration service, for every Pull Request and branch. The coverage is computed with the `codecode` package. The tests themselves are run using the `mocha` test runner. |
There was a problem hiding this comment.
Considering the following statement,
Test code should be written in syntax that runs on the oldest supported Node.js version, without transpiling.
the example file name exampleFile.spec.ts needs to be exampleFile.spec.js.
There was a problem hiding this comment.
Ah, no. All the tests in this project are written in TS. Therefore, just removing the part , without transpiling would be fine. 👍
| The documentation is built using [Jekyll](https://jekyllrb.com/) and hosted with GitHub Pages. | ||
| The source files are contained in the `docs` directory. They are broken up into the `_basic`, `_advanced`, and `_tutorials` directories depending on content's nature. | ||
|
|
||
| All documentation contains [front matter](https://jekyllrb.com/docs/front-matter/) that indicates the section's title, slug (for header), respective language, and if it's not a tutorial it contains the order it should appear within it's respective section (basic or advanced). |
There was a problem hiding this comment.
Also, the maintainers need to be aware of also updating Japanese translation (plus we may have other languages as well in the future) when they update documents.
I'm still not sure what the most easy-to-understand way to communicate regarding this matter for contributors is but one thing I can suggest is to have a more comprehensive checklist with categories (e.g., code change, documents, etc) in .github/pull_request_template.md.
There was a problem hiding this comment.
Yeah, I think pull_request_template.md may be a good place to indicate this. Maybe we could add a label for documentation that is Needs Translation, but I also don't want to wait to merge PRs that aren't translated yet since that could take some time.
Summary
Adds information about maintaining the package and addresses #229
Requirements (place an
xin each[ ])