Skip to content
/ default-template Public template

Default template to apply when creating a new repository

License

Notifications You must be signed in to change notification settings

reviewpad/default-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⚠️ This is a template for the README.md file. Please edit it accordingly to your project.

⚠️ Also, on the repository About ⚙️ section (on the right side of the page 👉)

  • Add a good Description;
  • Add a set of Topics that describe the project;

Project name

Choose a self-explaining name for your project.

Development

Prerequisites

List the prerequisites for running the project locally.

Environment variables

List the environment variables that are required to run the project locally.

VSCode

We strongly recommend using VSCode with the following extensions:

  • licenser for adding license headers.
  • editorconfig for enforcing consistent coding styles between different editors and IDEs.

Open the project in VSCode, open the command palette (Ctrl+Shift+P) and search for Preferences: Open Workspace Settings (JSON).

Paste the following configuration:

{
    "licenser.license": "Custom",
    "licenser.author": "Explore.dev, Unipessoal Lda",
    "licenser.customHeader": "Copyright (C) @YEAR@ @AUTHOR@ - All Rights Reserved\nUse of this source code is governed by a license that can be\nfound in the LICENSE file."
}

Debugging with VSCode

Explain how to debug the project using VSCode.

Deployment

Deploying to stage

Explain how to deploy the project to stage.

Deploying to production

Explain how to deploy the project to production.

License

This project is available under the GNU Lesser General Public License v3.0 license.

About

Default template to apply when creating a new repository

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks