Skip to content

Important files

The package.json file is the core of your project. It contains your project’s metadata, dependencies, scripts, and other configurations. You can find detailed information on the npm website.

The .gitignore file is used to specify which files should not be tracked by Git. This is useful to files that contain sensitive information or which are generated by your project. You can find detailed information on the Git website.

Sometimes overlooked, the README.md file is the starting point for your project documentation. This can include:

  • How to setup and run your project
  • How to contribute to the project
  • Further links to documentation

Supported by both GitHub and GitLab, a CODEOWNERS file allows you to define individuals or teams responsible for code (folders or files) in a repository. This helps streamline the review process by ensuring that relevant people are tagged and approve code changes for which they are responsible.