This repository includes examples of 'bad code'. The purpose of this repository is:
- to review the bad code;
- and to propose improvements.
To get started, complete the following steps:
- fork this repository;
- clone the forked version to your local file system.
Once the repository has been download, no further setup is required.
To use this repository, complete the following steps:
- navigate to the
src/
directory; - select the subfolder which corresponding to your langauge of interest (ie.
js/
); - select, open, and review one of the bad code examples;
- after identifying potential solutions/adjustments, create a new branch of the form:
fix/<file-name>/<your-name>
;- For example, given the
calculator.js
file and the name John, the resulting branch would befix/calculator.js/john
.
- For example, given the
- on the new branch, implement your solutions/adjustments;
- when you're finished, push the resulting branch to the remote and submit a pull request against the original repository.
Currently, Bad Code does not include any external documentation.
For an overview of the project's evolution, please consult the CHANGELOG.