Build Process

Automatic Linting

All javascript code being pushed onto the collection_team branch is automatically put through eslint and prettier to abide by a predetermined style guide.

Automatic Documentation Generation

In the same GitHub action that automatically lints javascript code in the collection_team branch, we use jsdoc to provide documentation. When writing the javascript, we use these block tags to generate the documentation.

Automatic Unit Testing

Jest is currently set up in an automatic GitHub action to run each time new code is pushed to the demo-team branch and checks that the LocalStorage.js file operates correctly using a couple tests.

Tools Used

• eslint
• prettier
• jsdoc
• jest

Note: All coding was done in vanilla javascript, css, and html. No outside frameworks or libraries were used.

Pull Request, Issue, and Branching Strategy

Pull Requests and Issues

Pull requests and issues should be assigned to any and all involved parties, given concise titles, and be given good descriptions. Both the titles and the descriptions should be in present tense. If they are on a general theme, then the title should follow: THEME: ......
Example: BUG FIX: Fixing Item objects that aren't saving.

Branches

There should never be any redundant branches and branches created with the sole purpose of merging into the main branch should be swiftly deleted after the pull request has been merged. As soon as a branch is no longer relevant, it should be merged (if necessary) and then deleted from the remote repository.

Labels to use

• bug
  • Used when describing a behavior or visual aspect that is not as expected.
• documentation
  • Used when discussing issues with code documentation.
• duplicate
  • Used when there is repetitive code, repetitive files, or there is simply made more of something than there should be.
• enhancement
  • Used when there is a new feature request.
• help wanted
  • Used when someone is working on a project and needs additional support.
• invalid
  • Used when something doesn't seem right.
• linting
  • Used when there is an issue with the way the repository is auto-listing code.
• question
  • Used when someone has a question.
• support
  • Used mainly by an outside party that is having issues with the application.
• unit testing
  • Used when there is a problem in the unit testing code or the general strategy of the application's unit tests.
• wontfix
  • Used to indicate that something will not be worked on.