Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.89 KB

SETUP.md

File metadata and controls

41 lines (30 loc) · 1.89 KB
Raw

Setup instructions

Before you start using this template, complete the following steps:

Required changes

  • Protect the main branch
  • Add a short description of the repository
  • Add tags for the repository
    • open-source,
    • technology tag (android in this case),
    • other tags that are relevant to the repository
  • Update the README.md file with the missing information
    • Delete the Setup instructions note from the file
    • Add the project name
    • Add the missing information based on the comments in the file
  • Add code owners to the .github/CODEOWNERS file if applicable
  • Define a changelog strategy1
  • Delete the SETUP.md file

Project information

If your project needs to provide additional information like backward compatibility or similar, include it to the README.md file of additional file in a clear and informative format (e.g. compatibility matrix, table, timeline, etc.). Also, if there is a need for additional information for contributors, additional security measures or specific license, update and adjust related files.

Issue templates

The same applies to issue and pull request templates, where you can adjust information based on the project requirements or required checks in the list (e.g., testing types, performance information, accessibility, etc.).

Optional changes

The repository files can be changed if the project requires it. If there is a project-specific need, feel free to update and adjust the following files:

  • Update the CODE_OF_CONDUCT.md file
  • Update the CONTRIBUTING.md file
  • Update the SECURITY.md file
  • Update the LICENSE file
  • Update the .gitignore file
  • Update the pull request template
  • Update issue templates

Footnotes

  1. Define how changes will be documented; e.g. Releases section in GitHub (the recommended way), usage of additional tools, etc. ↩