repository_settings_guidelines.md

Repository Settings Guidelines

This guideline outlines the recommended settings for your repository, using my project River-Charts as a practical example:

• To adjust your repository settings, click on the gear icon located next to the "About" section in the top right corner of your repository's main page.

---

Table of Contents

• Project Name
• Description
• Website
• Topics
• Misc. Settings
• Resources

Project Name

Consult the Category Guidelines to determine how to name your project.

Description

Warning

REQUIRED file for ALL tiers.

Use a description that is short and to the point. This is the first thing people will see when they visit your repository. Make it count!

• e.g. "A Python, Django, Plotly, and Pandas web application that visualizes river data pulled using an API from the United States Geological Survey (USGS)."

Website

Warning

OPTIONAL file for ALL tiers. Strongly encouraged if you're able to host a static website to demonstrate your project. Link the website to the banner_large.png file if it is for a Platinum or Gold tier project. Link the website to the banner_small.png file if it is for a Silver or Bronze tier project.

• PythonAnywhere is a great free option for hosting Python web applications.
  • e.g. http://scottgriv.pythonanywhere.com/
• GitHub Pages is a great free option for hosting static websites for your project.
  • Jekyll is a great static site generator that is built into GitHub Pages.
• Netlify is a great free option for hosting static websites for your project.
  • Hugo is a great static site generator that is built into Netlify.
  • Gatsby is a great static site generator that is built into Netlify.

Topics

Warning

REQUIRED file for ALL tiers.

• Fill out as many topics as you can, but don't overdo it - these are used for search results in GitHub so it will help people find your project.
• Topics should highlight the main technologies, frameworks, and languages used in the project.
  • e.g. visualization, python, api, charts, data, django, plotly, pandas, data-visualization, dataset, webapp, data-analysis, usgs, usgs-api

Misc. Settings

• Releases, Packages, Deployments should only be checked under "Include in the home page" if you're using those features.
• I strongly recommend using Releases for Platinum and Gold projects.
• Make sure you Pin your project to your profile if you want it to show up on your profile page.
  • Platinum and Gold projects should always be pinned to your profile.
• README files should always be included in your repository.
  • View Repository Structure Guidelines and README Guidelines for more information on how to setup your project structure and README file.

Resources

• Managing repository settings - You can choose the way your repository functions by managing repository settings.