Repository Template

A template for creating new @CodeMeKathy repositories

This repository is meant to serve as a general template for how to set up new CodeMeKathy repositories. In general, setting up a new repository should take only a few minutes; use this repository as a way of finding example files, and use the following checklist to ensure that you've set up the repository correctly.

Install

These instructions are basic; you can use any method to do this work. The important part is making sure that you follow the checklist below before publishing the repository.

✅ Checklist ✅

Go through this checklist after creating your repository.

README

Copy example-README.md from this repository to your directory.
Rename all instances of <Replace Title> in README to match the new repo title
Manually go through and edit the rest of the README file.

Dotfiles

Do you need a .gitignore file?
Do you need an .npmignore file?

License ?

Copy the MIT license from the example repo.
Have you added MIT as the license in the package.json?
If you made changes, were these reflected in the last section of the README?

GitHub Metadata

Have you added a short description to the repository?
- Is the description matched in the byline under the title in the README?
Have you added topics to the GitHub repository?
- Have you added these topics as keywords in the package.json?

`package.json`

Is the author field correct?
Have you added keywords?
Are the bugs and homepage fields correct?
Have you added tests? Are they matched, here?

CodeMeKathy / chingu-pw-clone