Skip to content

Refine project workflow#1534

Merged
lovelydinosaur merged 2 commits into
masterfrom
project-workflow
Mar 24, 2021
Merged

Refine project workflow#1534
lovelydinosaur merged 2 commits into
masterfrom
project-workflow

Conversation

@lovelydinosaur

Copy link
Copy Markdown
Contributor

Following up on discussion #1493

  • Issue and pull request templates guide contributors towards a "discussions first" workflow.
  • Include our code of conduct in the docs.
  • Add funding button to GitHub UI.
  • Upgrade our CONTRIBUTING.md to match the docs, move it into .github folder.

@lovelydinosaur

Copy link
Copy Markdown
Contributor Author

So, I know this is new territory, but am hoping that a discussions first workflow will help keep the "issues" and "pull requests" lists properly managed, and reduce the overall maintenance burden. It's the style I'm moving Django REST framework too, and likely other projects in Encode too.

As it stands we're actually managing okay in HTTPX, but practically every OSS project eventually succumbs to an ever growing list of "Issues" being opened which may or may not actually be valid, well described, or confirmed as reproducible. By switching to discussions first, the focus shifts - a discussion no longer needs to be "closed", and isn't considered an issue unless the team raises it into one.

We also want to help direct folks away from issuing pull requests without prior discussion. For example #1523 which is perfectly decently done, and is well intentioned, but may not be quite the API we actually want. This workflow change ought to help us discuss potential changes with contributors before they start work on the pull request itself.

Comment thread .github/CONTRIBUTING.md
@@ -0,0 +1,235 @@
# Contributing

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

How is this file used? Thoughts on using a "see docs" stub like we had before? Helps reduce duplication of info and sources.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Interface-wise, it gets linked to in this section...

(From the "New Issue" page)

Screen Shot 2021-03-24 at 16 36 06

I'm equally happy with it either as a copy of the docs, or as a simple docs link.

@florimondmanca

Copy link
Copy Markdown
Contributor

Will be a nice experiment. Happy to try discussions as the primary entry channel, especially as we've been waiting for them for so long! :)

@lovelydinosaur

Copy link
Copy Markdown
Contributor Author

Right, let's give this a go, and see how we get on with it.

@lovelydinosaur
lovelydinosaur merged commit 437b55c into master Mar 24, 2021
@lovelydinosaur
lovelydinosaur deleted the project-workflow branch March 24, 2021 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants