📚Miscellaneous and Resources

Misc. Info

• Enoch Bot is hosted on a free tier AWS EC2 instance

  • Rebecca has access to this

• Programming style

  • Use flake8 and black

  • Make your code readable by others

    • Write comments when appropriate

    • Name variables, classes, and methods appropriately

  • Include docstrings for all classes and methods (if it's not obvious)

    • Exception: Docstrings are required for all commands since the contents of the docstring is used for the command's help text

• Sensitive information (e.g. bot tokens, credentials, secrets, passwords, etc.)

  • Sensitive info should never be published publicly. For example, bot tokens should never be pushed to GitHub.

  • To share sensitive info, use One Time Secret

• Branches vs Tags: Note that on the Enoch Bot GitHub repository, some branches and tags have very similar names (e.g. branch 2.2.0 and tag v2.2.0).

  • Note that branches won't contain "v" in front of the version number. The branches are automatically created by GitBook to manage the different variants of the documentation.

  • On the other hand, tags do contain "v" in front of the version number. Git commits are manually tagged based on changes made in that version.

Resources

Python

• Python3 Documentation
• Style/Linting/Formatting

  • flake8 Documentation
  • black Documentation
• pip Documentation

SQL

• sqlite3 Documentation
• SQLite Documentation
• W3Schools SQL Tutorial

Discord

• Discord.py API Documentation

  • See also: Special Thanks tutorials
• discord_slash API Documentation
• Discord API Documentation
• Discord Developer Portal

Google Sheets

• Google Sheets API Documentation

Git

• Git Documentation
• Learn Git

  • Git - the simple guide
  • Git Explorer
  • FTC Omega 9656 Learn Code Unit 7: Git
  • Ultimate Git Resource
• Version Control

  • Manage Your File Versioning Like a Pro with Git
  • Semantic Versioning
• Basic Tagging

  • How to Use Git Tag
  • Git Tagging - A Brief Guide

GitHub, Issues, and Pull Requests

• GitHub Documentation

  • GitHub Actions Documentation
• Learn GitHub

  • GitHub Learning Lab
  • FTC Omega 9656 Learn Code Unit 7: Github
• Labels

  • Managing Labels
  • Adding Labels to Issues
  • Managing Default Labels
• Reviews

  • About Pull Request Reviews
  • Reviewing Proposed Changes
  • Viewing a Pull Request Review
  • Approving a Pull Request with Required
  • Dismissing a Pull Request Review
• Pull Requests

  • About Pull Requests
  • Creating a Pull Request
  • Creating a Pull Request from a Fork
  • Requesting a Review
  • Changing the Base Branch of a Pull Request
  • Linking an Issue to a Pull Request
• Milestones

  • About Milestones
  • Creating and Editing Milestones
  • Adding a Milestone
  • Filtering by Milestones
  • Viewing the Progress of a Milestone
• Actions

  • About Custom Actions
  • Docker Container Actions
  • Javascript Actions
  • Composite Actions
• Workflows

  • Running a Workflow
  • Re-running a Workflow
  • Canceling a Workflow
  • Disabling and Enabling a Workflow
  • Deleting a Workflow Run

AWS

• AWS Documentation

  • ec2 Documentation

Heroku

• Heroku Documentation

  • Heroku CLI Documentation
  • Heroku Dynos Documentation
  • Heroku Deploying with Git Documentation
  • Heroku Python Documentation
• Getting Started on Heroku with Python
• See also: Special Thanks tutorials

Documentation

• GitBook Documentation
• Markdown Guide