Table of Contents

Contribution files

While not directly related to the build system, these files will improve the collaboration in your project. Consider adding them:

  • README.md: include at least the main features, screenshots, getting started or links to documentation and build & release instructions.
  • LICENSE: information about the license. Check choose a license.
  • SECURITY.md: information how to report vulnerabilities properly.
  • Community:
    • CONTRIBUTING.md: explain how to create issues and pull requests.
    • CODE_OF_CONDUCT.md: GitHub can help to create it.
  • IDE support:
    • .editorconfig: code styles and code warnings.
    • .vscode/: VS Code support to build, run and debug the project.
  • GitHub issues / PR:

code of conduct preview