• Table of Contents
• Step 1: Build from Source
• Step 2: Configuring Git and GitHub for Development
  • Create your fork
  • Configure remotes
  • Authenticating with GitHub
• Guidelines

To work onpython-template-rust, you are going to need to build it from source. SeeBuild from Source fordetailed build instructions.

Once you've builtpython-template-rust from agit clone, you will also need toconfiguregit and your GitHub account forpython-template-rust development.

The first step is to create a personal fork ofpython-template-rust. To do so, clickthe "fork" button athttps://github.com/python-project-templates/python-template-rust, or just navigatehere in your browser. Set theowner of the repository to your personal GitHub account if it is notalready set that way and click "Create fork".

Next, you should set some names for thegit remotes corresponding tomain python-project-templates repository and your fork. See theGitHub Docs for more information.

If you have not already configuredssh access to GitHub, you can findinstructions to do sohere,including instructions to create an SSH key if you have not doneso. Authenticating with SSH is usually the easiest route. If you are working inan environment that does not allow SSH connections to GitHub, you can look intoconfiguring a hardwarepasskeyor adding apersonal accesstokento avoid the need to type in your password every time you push to your fork.

After developing a change locally, ensure that bothlints andtests pass. Commits should be squashed into logical units, and all commits must be signed (e.g. with the-s git flag). We requireDeveloper Certificate of Origin for all contributions.

If your work is still in-progress, open adraft pull request. Otherwise, open a normal pull request. It might take a few days for a maintainer to review and provide feedback, so please be patient. If a maintainer asks for changes, please make said changes and squash your commits if necessary. If everything looks good to go, a maintainer will approve and merge your changes for inclusion in the next release.

Please note that non substantive changes, large changes without prior discussion, etc, are not accepted and pull requests may be closed.