Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

72 lines (50 loc) · 3.37 KB
Raw

Contributing to VSGAN

Thank you for considering contributing to VSGAN!

Support questions

Please don't use the issue tracker for this. The issue tracker is a tool to address bugs and feature requests in VSGAN itself. Use one of the following resources for questions about using VSGAN or issues with your own code:

Reporting issues

Include the following information in your post:

  • Describe what you expected to happen.
  • If possible, include a minimal reproducible example to help us identify the issue. This also helps check that the issue is not with your own code.
  • Describe what actually happened. Include the full traceback if there was an exception.
  • List your Python and VSGAN versions, you can provide a commit SHA for VSGAN. If possible, check if this issue is already fixed in the latest code in the repository.

Submitting patches

If there is not an open issue for what you want to submit, prefer opening one for discussion before working on a PR. You can work on any issue that doesn't have an open PR linked to it or a maintainer assigned to it. These show up in the sidebar. No need to ask if you can work on an issue that interests you.

Include the following in your patch:

  • Make sure you test your changes or new additions.
  • Update any relevant docs pages and docstrings. Doc pages and docstrings should be wrapped at most 116 characters.

First time setup

The entire process of setting up your Development environment to work on VSGAN can be found on the Building documentation. It guides you through the download, preparation, and installation of the source code. I recommend working on the source code through Git, and from a Fork of the repository.

Start coding

  • Don't forget to install pre-commit so your commits are checked for code syntax, format, and quality.
  • Create a branch to identify the issue you would like to work on. Do not work directly off the main/master branch. Branch off of the origin/master branch for the latest upstream changes.
$ git fetch origin
$ git checkout -b your-branch-name origin/main
  • Using your favorite editor, make your changes, committing as you go.
  • Make sure you fully test all changes and additions from as many directions and edge cases as possible.
  • Changes must pass a MyPy and Flake8 test with no errors and minimal to no warnings.
  • Push your commits to your fork on GitHub and create a pull request. Link to the issue being addressed with fixes #123 in the pull request to automatically link the issue and mark the PR as a fix.
$ git push --set-upstream fork your-branch-name