CONTRIBUTING.md

Contributing to one of Our Projects

Our projects are open-source and are automatically deployed whenever commits are pushed to the main branch on each repository, so we've created a set of guidelines in order to keep everything clean and in working order.

Note that contributions may be rejected on the basis of a contributor failing to follow these guidelines.

Rules

1. No force-pushes or modifying the Git history in any way.
2. If you have direct access to the repository, create a branch for your changes and create a pull request for that branch. If not, create a branch on a fork of the repository and create a pull request from there.
   • It's common practice for a repository to reject direct pushes to main, so make branching a habit!
   • If PRing from your own fork, ensure that "Allow edits from maintainers" is checked. This gives permission for maintainers to commit changes directly to your fork, speeding up the review process.
3. Adhere to the prevailing code style, which we enforce using flake8 and pre-commit.
   • Run flake8 and pre-commit against your code before you push it. Your commit will be rejected by the build server if it fails to lint.
   • Git Hooks are a powerful git feature for executing custom scripts when certain important git actions occur. The pre-commit hook is the first hook executed during the commit process and can be used to check the code being committed & abort the commit if issues, such as linting failures, are detected. While git hooks can seem daunting to configure, the pre-commit framework abstracts this process away from you and is provided as a dev dependency for this project. Run pipenv run precommit when setting up the project and you'll never have to worry about committing code that fails linting.
4. Make great commits. A well structured git log is key to a project's maintainability; it efficiently provides insight into when and why things were done for future maintainers of the project.
   • Commits should be as narrow in scope as possible. Commits that span hundreds of lines across multiple unrelated functions and/or files are very hard for maintainers to follow. After about a week they'll probably be hard for you to follow too.
   • Avoid making minor commits for fixing typos or linting errors. Since you've already set up a pre-commit hook to run the linting pipeline before a commit, you shouldn't be committing linting issues anyway.
   • A more in-depth guide to writing great commit messages can be found in Chris Beam's How to Write a Git Commit Message
5. Avoid frequent pushes to the main repository. This goes for PRs opened against your fork as well. Our test build pipelines are triggered every time a push to the repository (or PR) is made. Try to batch your commits until you've finished working for that session, or you've reached a point where collaborators need your commits to continue their own work. This also provides you the opportunity to amend commits for minor changes rather than having to commit them on their own because you've already pushed.
   • This includes merging main into your branch. Try to leave merging from main for after your PR passes review; a maintainer will bring your PR up to date before merging. Exceptions to this include: resolving merge conflicts, needing something that was pushed to main for your branch, or something was pushed to main that could potentionally affect the functionality of what you're writing.
6. Don't fight the framework. Every framework has its flaws, but the frameworks we've picked out have been carefully chosen for their particular merits. If you can avoid it, please resist reimplementing swathes of framework logic - the work has already been done for you!
7. If someone is working on an issue or pull request, do not open your own pull request for the same task. Instead, collaborate with the author(s) of the existing pull request. Duplicate PRs opened without communicating with the other author(s) and/or PyDis staff will be closed. Communication is key, and there's no point in two separate implementations of the same thing.
   • One option is to fork the other contributor's repository and submit your changes to their branch with your own pull request. We suggest following these guidelines when interacting with their repository as well.
   • The author(s) of inactive PRs and claimed issues will be be pinged after a week of inactivity for an update. Continued inactivity may result in the issue being released back to the community and/or PR closure.
8. Work as a team and collaborate wherever possible. Keep things friendly and help each other out - these are shared projects and nobody likes to have their feet trodden on.
9. All static content, such as images or audio, must be licensed for open public use.
   • Static content must be hosted by a service designed to do so. Failing to do so is known as "leeching" and is frowned upon, as it generates extra bandwidth costs to the host without providing benefit. It would be best if appropriately licensed content is added to the repository itself so it can be served by PyDis' infrastructure.

Above all, the needs of our community should come before the wants of an individual. Work together, build solutions to problems and try to do so in a way that people can learn from easily. Abuse of our trust may result in the loss of your Contributor role.

Changes to this Arrangement

All projects evolve over time, and this contribution guide is no different. This document is open to pull requests or changes by contributors. If you believe you have something valuable to add or change, please don't hesitate to do so in a PR.

Supplemental Information

Developer Environment

Instructions for setting the bot developer environment can be found on the PyDis wiki

To provide a standalone development environment for this project, docker compose is utilized to pull the current version of the site backend. While appropriate for bot-only contributions, any contributions that necessitate backend changes will require the site repository to be appropriately configured as well. Instructions for setting up the site environment can be found on the PyDis site.

When pulling down changes from GitHub, remember to sync your environment using pipenv sync --dev to ensure you're using the most up-to-date versions the project's dependencies.

Type Hinting

PEP 484 formally specifies type hints for Python functions, added to the Python Standard Library in version 3.5. Type hints are recognized by most modern code editing tools and provide useful insight into both the input and output types of a function, preventing the user from having to go through the codebase to determine these types.

For example:

import typing as t


def foo(input_1: int, input_2: t.Dict[str, str]) -> bool:
    ...

Tells us that foo accepts an int and a dict, with str keys and values, and returns a bool.

All function declarations should be type hinted in code contributed to the PyDis organization.

For more information, see PEP 483 - The Theory of Type Hints and Python's documentation for the typing module.

AutoDoc Formatting Directives

Many documentation packages provide support for automatic documentation generation from the codebase's docstrings. These tools utilize special formatting directives to enable richer formatting in the generated documentation.

For example:

import typing as t


def foo(bar: int, baz: t.Optional[t.Dict[str, str]] = None) -> bool:
    """
    Does some things with some stuff.

    :param bar: Some input
    :param baz: Optional, some dictionary with string keys and values

    :return: Some boolean
    """
    ...

Since PyDis does not utilize automatic documentation generation, use of this syntax should not be used in code contributed to the organization. Should the purpose and type of the input variables not be easily discernable from the variable name and type annotation, a prose explanation can be used. Explicit references to variables, functions, classes, etc. should be wrapped with backticks (`).

For example, the above docstring would become:

import typing as t


def foo(bar: int, baz: t.Optional[t.Dict[str, str]] = None) -> bool:
    """
    Does some things with some stuff.

    This function takes an index, `bar` and checks for its presence in the database `baz`, passed as a dictionary. Returns `False` if `baz` is not passed.
    """
    ...

Logging Levels

• TRACE: These events should be used to provide a verbose trace of every step of a complex process. This is essentially the logging equivalent of sprinkling print statements throughout the code.
• DEBUG: These events should add context to what's happening in a development setup to make it easier to follow what's going while working on a project. This is in the same vein as TRACE logging but at a much lower level of verbosity.
• INFO: These events are normal and don't need direct attention but are worth keeping track of in production, like checking which cogs were loaded during a start-up.
• WARNING: These events are out of the ordinary and should be fixed, but have not caused a failure.
  • NOTE: Events at this logging level and higher should be reserved for events that require the attention of the DevOps team.
• ERROR: These events have caused a failure in a specific part of the application and require urgent attention.
• CRITICAL: These events have caused the whole application to fail and require immediate intervention.

Ensure that log messages are succinct. Should you want to pass additional useful information that would otherwise make the log message overly verbose the logging module accepts an extra kwarg, which can be used to pass a dictionary. This is used to populate the __dict__ of the LogRecord created for the logging event with user-defined attributes that can be accessed by a log handler. Additional information and caveats may be found in Python's logging documentation.

Work in Progress (WIP) PRs

Github provides a PR feature that allows the PR author to mark it as a WIP. This provides both a visual and functional indicator that the contents of the PR are in a draft state and not yet ready for formal review.

This feature should be utilized in place of the traditional method of prepending [WIP] to the PR title.

As stated earlier, ensure that "Allow edits from maintainers" is checked. This gives permission for maintainers to commit changes directly to your fork, speeding up the review process.