Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 3.13 KB
Raw

Content Guidelines

All contributions to this project must comply with our Code of Conduct.

Additionally, contributions must not contain contain content that:

  • is prohibited by Github's terms of service
  • is illegal in the United Kingdom, the United States, or your country of residence
  • is pornographic or otherwise sexualized
  • breaches the Intellectual Property, including but not limited to Copyright, Patent or Trademark, rights of any party under United Kingdom, United States or international IP law
  • is blasphemous
  • explicitly supports or opposes any political party, religion, candidate for election to political or religious office, or person holding political or religious office
  • mocks, caricatures or insults a Head of State or Royal Family
  • advertises goods or services offered by the contributor
  • endorses or advocates for colonialism, slavery or involuntary servitude, now, in the past or in the future
  • supports or depicts war or weapons or violence against any human being or animal
  • explicitly supports or opposes any party to a war or other military conflict
  • is libellous, defamatory or contains unsubstantiated criticism of a person, company or organization
  • is legal, financial, investment or medical advice
  • promotes any regulated securities or financial product in the United Kingdom or the United States

Style Guide

This project uses Python 3.

For consistency, it is preferred that you use American spellings when working on code or documentation for this project.

Branch conventions

All branches should be created from the parent branch and the branch name should include your name.

Issues

Issue templates are provided for most scenarios. If the issue you want to make fits one of the scenarios, please fill out the provided issue template.

Pull requests

Pull requests should reference an issue. Please also follow any specific instructions on the issue you are referencing.

Contributions to the artwork should include a description/explanation of what your contribution.

Steps for making your contribution

Assignment

Unless the issue is marked 'assignment not required' please comment on the issue you want to work on and wait to be assigned before starting to work on it.

Git workflow

  • Fork the repository to your personal Github account.
  • Clone the repository to your local machine.
  • Add this repository as a remote git remote add upstream https://github.com/dominicduffin1/python-turtle-art-canvas.git.
  • Create a branch.
  • Write the code.
  • Please pull parent into your branch before making a pull request git pull upstream parent.
  • Push your branch to your forked version of the repositroy.
  • Open a pull request against the parent branch of this repository.

General

The language of this project is English and it is expected that all communication be in English. Please do not worry if you are not that confident writing in English, we will do our best to understand what you write and to ask for clarifications if necessary.