Thank you for taking the time to read our contribution guidelines. You can start contributing in many ways like filing bug reports, improving the documentation, and helping others.
- Hyperapp is written in ES3. Please don't create an issue asking us to rewrite it in ES6 or TypeScript.
- We use Prettier to format the code. If you don't have Prettier installed in your code editor or IDE, you can use
npm run formatbefore creating a commit. - We prefer keeping all the moving parts inside as few files as possible. We don't have plans to break up the library into smaller modules. If you are looking for a Virtual DOM implementation without Hyperapp's built-in state management check out Picodom.
- Before submitting a bug report, search the issues for similar tickets. Your issue may have already been discussed and resolved. Feel free to add a comment to an existing ticket, even if it's closed.
- Determine which repository the problem should be reported in. If you have an issue with the Router, you'll be better served in hyperapp/router, etc.
- If you have a question or need help with something you are building, hop on Slack.
- Be thorough in your title and report, don't leave out important details, describe your setup and include any relevant code with your issue.
- Please use GitHub fenced code blocks when sharing code. If your code has JSX in it, use ```jsx for best syntax highlighting.
- We use Babel and Jest for testing.
- Feel free to create a new
test/*.test.jsfile if none of the existing test files suits your test case. - Tests usually consist of an application demonstrating a feature, then check if document.body.innerHTML matches some string. Because the app call is asynchronous we often use oncreate and onupdate events to detect when an element has been rendered on the DOM.
Our open source community strives to be nice, welcoming and professional. Instances of abusive, harassing, or otherwise unacceptable behavior can be reported by contacting us at [email protected].