Skip to content

Contributor Onboarding Improvements #36

@cybardev

Description

@cybardev

Some suggestions to consider to make onboarding easier:

  • Add .prettierrc and eslint.config.js files for project-level configuration
    • needed because we want to have everyone on the same page regardless of their global customizations of Prettier and ESLint
    • needs to be done by a ShiftKey member
  • Add example pre-commit hooks to format and lint code, and prevent commits that don't follow style guidelines
    • the user will get a log of what happened and resolve it locally before attempting to commit again
    • needs both yarn and npm scripts
    • potential good first issue for contributors
  • Explain how to use the aforementioned scripts and configs in CONTRIBUTING.md

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions