Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formalizing TypeScript dependency #3

Closed
jugglinmike opened this issue Feb 10, 2022 · 3 comments
Closed

Formalizing TypeScript dependency #3

jugglinmike opened this issue Feb 10, 2022 · 3 comments

Comments

@jugglinmike
Copy link
Contributor

In an effort to maintain parity with the ARIA-AT projects, this project uses JavaScript rather than TypeScript. Because we recognize the benefit of static typing, we have been annotating the JavaScript source code with specially-formatted comments which contain that information. Some of us have configured our development environments to consume those annotations and inform us of problems.

We'd like to formalize the dependency so that future contributors can benefit from the extra information, be informed of mistakes, and help us preserve it. We're not currently interested in writing TypeScript code in this repository. For now, we want to extend the project documentation and contribution workflow to acknowledge the structured JavaScript comment system that's already in use.

Do folks agree that the current state of affairs is unideal? Do you think that it would be disruptive for future contributors to find the more strict conventions in this project, even if we make those documentation and workflow improvements?

@zcorpan
Copy link
Member

zcorpan commented Feb 14, 2022

Is this convention lintable?

@jugglinmike
Copy link
Contributor Author

Yup: machine-powered validation is the workflow extension I have in mind.

@mzgoddard
Copy link
Contributor

w3c/aria-at-automation-driver#38 is an example of some of the work that can be done under formalizing a typescript dependency in this repo and other related aria-at repos. (Wanted to put a link between this issue and that PR for historical use.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

4 participants