Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document best practices when creating a new app #179

Open
6 tasks
christinach opened this issue May 9, 2024 · 0 comments
Open
6 tasks

Document best practices when creating a new app #179

christinach opened this issue May 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@christinach
Copy link
Member

christinach commented May 9, 2024

Introduction

The goal of this documentation is to document in our handbook best practices when creating a new application.

Acceptance criteria

  • Identify the applications as frontend, backend or combined.

  • It has introduction: Explains the goals and purpose of this documentation.

  • It has a step by step guide: Provides the exact steps to guide the user on how to do a task.

  • Steps to consider:
    - [ ] Testing packages,
    - [ ] Installation packages (yarn/npm/bundle)
    - [ ] Linting and Formatting code packages, (eslint, prettier, rubocop )
    - [ ] Lint before committing (simple-git-hooks, lint-staged)
    - [ ] CI/CD (circleci , github actions etc.)
    - [ ] Logs
    - [ ] Honeybadger
    - [ ] Documentation (docs directory)
    - [ ] Security (dependabots, semgrep, CodeQl scan)
    - [ ] Environments needed (VMs for staging and production). Names should have -staging.princeton.edu, -production.princeton.edu
    - [ ]

Additional acceptance criteria

  • It includes references: References any related resources that have assisted creating this documentation (links to similar work on other applications).

  • It includes workflow: Defines the steps in different environments (production, staging)

@christinach christinach added the documentation Improvements or additions to documentation label May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant