Skip to content

This template provides a collection of base files for the creation of repositories in the BESSER-PEARL organization.

License

Notifications You must be signed in to change notification settings

BESSER-PEARL/template

 
 

Repository files navigation

Template for BESSER-PEARL Organization Repositories

This Github template provides a collection of base files and configuration recommendations for kick-starting a new project in the BESSER-PEARL organization.

⚒️ Using this template for your project

To use this template when creating a new repository in the BESSER-PEARL GitHub organization, you have to set the Repository template field to BESSER-PEARL/template.

The new repository will use this one as a template, meaning that it will contain all the files. Once the new repository is created, you can edit its files to adapt them to your needs.

☑️ Guidelines & Contributing

You will find a guided description of the steps you should follow in the guidelines file.

📓 Publishing the documentation to ReadTheDocs

This template also provides the base files to deploy the repository documentation using ReadTheDocs. In the docs folder you can find and edit all the Sphinx documentation sources. You can check the documentation generated from this template at the following link.

For more information on how to connect your repository, customize, and deploy the documentation with ReadTheDocs, you can follow this tutorial. If you do not plan to use ReadTheDocs, remove the docs folder and the .readthedocs.yaml file from your repository.

📚 References

This project is an extended and adapted version (to the BESSER-PEARL organization) of the GitHub Best Practices Template

About

This template provides a collection of base files for the creation of repositories in the BESSER-PEARL organization.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published