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

docs(readme, contributing): amend grammar and specificity #8

Merged
merged 3 commits into from
Feb 28, 2019

Conversation

jsdevtom
Copy link

No description provided.

@jsdevtom
Copy link
Author

jsdevtom commented Jan 18, 2019

Other notes/ suggestions:

readme.md

  • In readme.md there is a line "And adapt the path to your environment.". What path is being referred to? What environment?
  • There is a link to the wiki page regarding creating a hvstr config file. In the wiki there is nothing about creating a hvstr config file. This should probably be documented in readme.md

E2eIdDirective

  • Consider exporting e2e-id-directive so that users don't have to copy code out of our project in to their own. (Imagine you had to do that on some random repo that you had no idea about).

CONTRIBUTING.md

  • Here the 'format of the commit message' is linked to an other owner's gist. Is this intentional?
  • Do we really have a Gitter channel? If so where is the link?

samples/quickstart/

The requires and registers are not awaited here. Are we sure that this works? Has following the instructions exactly been tried on a fresh angular app?

General

  • The repo's name doesn't follow npm's specification:

New packages must not have uppercase letters in the name.
- https://docs.npmjs.com/files/package.json#name

  • Is the Wiki page automatically generated? It looks like the typedoc PR could replace a lot of this information automatically? If so, we could link to a GitHub pages site where typedoc is hosted

@MichaRedM
Copy link
Contributor

MichaRedM commented Feb 27, 2019

E2eIdDirective -> #9
repo's name-> #10

The Gitterchannel will be created soon.

@MichaRedM MichaRedM merged commit 176cced into master Feb 28, 2019
@MichaRedM MichaRedM deleted the documentation_suggestions branch February 28, 2019 07:31
@MichaRedM
Copy link
Contributor

The register method from ts-node is not async

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants