Skip to content
This repository has been archived by the owner on Jul 3, 2023. It is now read-only.

[docs] restructure 'how to contribute' in developer guide #223

Merged
merged 4 commits into from
Nov 1, 2022
Merged

[docs] restructure 'how to contribute' in developer guide #223

merged 4 commits into from
Nov 1, 2022

Conversation

jameslamb
Copy link
Contributor

Contributes to #51.

Changes

This PR proposes restructuring the "How to contribute" section in the developer guide, to hopefully make contributing easier for a wider range of possible contributors.

  • removes assumption that contributors are using PyCharm
  • removes assumption that contributors are on Macs (i.e. no brew install)
  • adds code blocks to make instructions copy-pasteable
  • replaces reference to "master" branch with "main"
  • removes incorrect statement that the CI tests will only run on push if you are in the stitchfix organization

Testing

pre-commit run --all-files

Notes

I've never used virtualenv prior to contributing on this project (I typically use conda/mamba or just Docker instead), so please correct me if I've said anything incorrect about virtualenv or if the pattern I've documented here is different from what you'd like contributors to follow.

Thanks for your time and consideration.

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Python - local testing

  • python 3.6
  • python 3.7

Copy link
Collaborator

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. @jameslamb thoughts on my additions?

developer_setup.md Outdated Show resolved Hide resolved
developer_setup.md Show resolved Hide resolved
@skrawcz skrawcz merged commit fb36f25 into stitchfix:main Nov 1, 2022
@jameslamb jameslamb deleted the docs/dev-setup branch November 1, 2022 12:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants