Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING Guide #177

Merged
merged 2 commits into from
Aug 29, 2023
Merged

Add CONTRIBUTING Guide #177

merged 2 commits into from
Aug 29, 2023

Conversation

elsiehupp
Copy link
Member

Considering the frustrations with our development process, I figured it was well past time to put together a written set of best practices.

This Pull Request partially addresses @NyaMisty's Issue #82 (but not fully), so @mediawiki-client-tools @yzqzss everyone please do comment on this and make or suggest any changes.

(I am marking as a draft in order to give everyone time to respond before this gets merged.)

Note that as @robkam mentioned, the "Code of Conduct" is kind of a separate Issue from the "Contributing" guide; I can open a Pull Request for that next.

Signed-off-by: Elsie Hupp <github@elsiehupp.com>
@robkam
Copy link
Member

robkam commented Aug 27, 2023

I'm not sure what's meant on line 55 by "You don't have to do so up front, but we ask that you do so when you...". Otherwise it looks fine.

@elsiehupp
Copy link
Member Author

I'm not sure what's meant on line 55 by "You don't have to do so up front, but we ask that you do so when you...". Otherwise it looks fine.

It means "You don't have to do so up front, but we ask that you [follow these best practices for writing a commit message] when you [open a pull request]," but, yeah, the wording is a bit awkward...

(By the way, you should be able to make commits on this Pull Request yourself, if you'd like to tweak the wording. I did this myself on one of your recent Pull Requests.)

clarifying the wording about commits
@randomnetcat
Copy link
Collaborator

randomnetcat commented Aug 28, 2023

The main substance lgtm. Haven't carefully examined the wording but can do so later.

@elsiehupp elsiehupp marked this pull request as ready for review August 28, 2023 17:04
Copy link
Member Author

@elsiehupp elsiehupp 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! (EDIT: Rob's changes, that is.)

@elsiehupp elsiehupp mentioned this pull request Aug 28, 2023
@elsiehupp elsiehupp merged commit bea45ec into python3 Aug 29, 2023
5 checks passed
@elsiehupp elsiehupp deleted the contributing-readme branch August 29, 2023 08:51
elsiehupp added a commit that referenced this pull request Aug 29, 2023
Fixes
#82.

This branch is based on
#177, so
it cannot be merged before the CONTRIBUTING branch is merged.

Note that I believe it is less than ideal for me, Elsie Hupp, to have
sole responsibility for CoC reports, but I also think it's better to
have an initial framework in place rather than none at all.

---------

Signed-off-by: Elsie Hupp <github@elsiehupp.com>
Co-authored-by: Rob Kam <robkam@gmx.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants