Skip to content

Update the contributing guide #638

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

Merged
merged 2 commits into from
May 31, 2021

Conversation

17cupsofcoffee
Copy link
Collaborator

@17cupsofcoffee 17cupsofcoffee commented May 22, 2021

🖼️ Rendered

I had some free time today, so I've had a stab at updating the contributing guide to line up with our new process/rules. I think I've included everything from the coordination issue guidelines (plus a few things that had been missed off).

I also tried to condense the instructions down a bit so that they're a bit easier to follow and focus on the info people need to contribute sections. I've moved the bits focusing on the process into a new section, and added a bit more info on what we do as the editors.

Let me know what you think, happy to tweak if you think anything's been lost in translation :)

@ozkriff ozkriff requested review from ozkriff, AngelOnFira and kvark May 23, 2021 10:10
@Keavon
Copy link
Contributor

Keavon commented May 24, 2021

Would this be a good place to propose we get rid of the nonsensical linter requirement for a line length limit in markdown files? It's
seriously quite a pain and provides no benefit.

@17cupsofcoffee
Copy link
Collaborator Author

17cupsofcoffee commented May 25, 2021

@Keavon I'm not particularly attached to the line length limit (and if we do keep it, it might make sense to bump it up to 120 characters or something like that), but will see what the other maintainers think.

@Keavon
Copy link
Contributor

Keavon commented May 25, 2021

Since 120 characters is shorter than a paragraph, that wouldn't really be an improvement. Let's stick to proposing no limit.

@ozkriff ozkriff mentioned this pull request May 31, 2021
@ozkriff
Copy link
Member

ozkriff commented May 31, 2021

Would this be a good place to propose we get rid of the nonsensical linter requirement for a line length limit in markdown files?

@Keavon this PR doesn't change the current guidelines, it just tries to document them. I've created a separate issue for line length discussion: #639

Copy link
Member

@ozkriff ozkriff left a comment

Choose a reason for hiding this comment

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

👍 much shorter and still includes all the important stuff

@17cupsofcoffee
Copy link
Collaborator Author

Cool, I'll merge this in a few hours if there's no objections? Would be good to be able to link to this in the next co-ordination issue.

Will make further edits if the consensus on #639 ends up being to remove the line length limits 👍

@17cupsofcoffee 17cupsofcoffee merged commit e4c970c into source May 31, 2021
@17cupsofcoffee 17cupsofcoffee deleted the 17cupsofcoffee-contributing-guide branch May 31, 2021 14:22
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.

3 participants