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

List of issues to revisit at the end of merging dev branch #626

Closed
1 of 11 tasks
henrikingo opened this issue Oct 9, 2017 · 3 comments
Closed
1 of 11 tasks

List of issues to revisit at the end of merging dev branch #626

henrikingo opened this issue Oct 9, 2017 · 3 comments

Comments

@henrikingo
Copy link
Member

henrikingo commented Oct 9, 2017

I will use this ticket as a notepad of issues that have been pointed out during the series of PRs into the dev branch, that I intend to return to do (or at least discuss) later, once all of my fork has been merged over. Each bullet point can be broken out as a separate issue later (or just do it).

  • All new plugins lack test coverage
  • Add documentation how to write tests (e.g. explain the approach with the iframe, where to add tests...)
  • Add an entry in circle.yml that checks that js/impress.js does in fact contain the output of build.js (Check that developer remembered to do node build.js before git commit.)
  • Change gc.addCallback to gc.pushCallback
  • Btw, gc library could be refactored so that the different types of objects pushed go into the same stack, and are iterated together in teardown, not separately by type.
  • Create a ticket for introducing jsdoc for API / code documentation
  • Move to uglify-es to support ES6 for minified impress.min.js compilation
  • Discuss: Can we remove the code that attempts to support more than one root element per window/frame? A lot of other code, such as getElementFromHash (or key navigation plugin) doesn't really support it anyway.
  • bower.json: Is this file still up to date? Is it needed? Do we upload a bower package somewhere?
  • karma.conf-sauce.js: Safari and IE didn't work with the new iframe based approach to testing. Figure out if there's some option one can use to allow javascript to access the DOM inside the iframe.
  • karma.conf-sauce.js should share the files: and proxies: sections with karma.conf.js so that they don't need to be updated in 2 places
@henrikingo henrikingo changed the title List of issues to revisit at the end of mergin dev branch List of issues to revisit at the end of merging dev branch Oct 9, 2017
@bartaz
Copy link
Member

bartaz commented Oct 9, 2017

I was thinking about something like this. Thanks for creating it!

@FagnerMartinsBrack
Copy link
Member

FagnerMartinsBrack commented Oct 9, 2017

I have edited the comment to convert to checkboxes and add some inline code markup, hope you don't mind.

Create a ticket for introducing jsdoc for API / code documentation

To that point, we should probably take some care to not tell what the code does internally in the form of comments. I see the value of using JSDocs for plugin documentation.

You might also be interested in checking out doclets.io for that matter.

@henrikingo
Copy link
Member Author

Created: #657 #658 #659 #660 #661 #662 #663 #664 #665 #666

Closing this issue.

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

No branches or pull requests

3 participants