Home

Welcome to the Quick JavaScript Refreshers Wiki!

Contributing

We welcome a variety of contributions to this repository, including:

• Your own JavaScript mini-projects with detailed commentary
• Bug reports and fixes
• Feature requests and implementations
• Improved documentation
• Increased test coverage

Contributing Process

To make a contribution, follow these steps:

1. Fork the repository.
2. Create a new branch with a descriptive name (e.g. fix-typo-in-readme).
3. Make your changes on the new branch.
4. Run tests to ensure everything is working properly.
5. Commit your changes with a descriptive commit message.
6. Push your changes to your forked repository.
7. Submit a pull request to the original repository.

Code Style

Please follow the coding style used in the original repository. Our goal is to have clear and concise JavaScript examples that serve as quick refreshers for key concepts, methods, and more.

To achieve this, the following is required:

1. Include in-code comments or an associated markdown file that provides step-by-step commentary to help readers understand the concepts behind the code.
2. Give files descriptive names to indicate their purpose as learning or refresher tools.
3. If your code requires expected inputs and outputs, include an associated Jest file for testing purposes. You can find an example in the following directory:

Sample Jest File and Structure

Official Jest Documentation

If a Jest file is not feasible, provide a detailed multiline comment explaining the expected inputs/outputs in the code or in the pull request description. Our review team will test the code before merging.

4. When merging new files into the repository, provide a clear and concise description of the files and the concepts they reinforce.

Clear commit messages for updates to existing files are fine

Asking a question

Submit an issue to this repository