Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.

Conversation

@wbrgss
Copy link
Contributor

@wbrgss wbrgss commented Jul 24, 2018

Follow-up on a task in the onboarding checklist:

I have access to the Github repos I need to do my work and I've read their CONTRIBUTING docs or complained that they don't exist

The advantage of having a CONTRIBUTING.md file is that GitHub will suggest reading it when contributors open their first issue or PR:

PR alert

I'm not intimately familiar with the workflow on this repo, so this should be considered a first stab at a more helpful guide, especially for open source contributors. Related: PR #243 on dash-core-components

Copy link
Member

@cldougl cldougl left a comment

Choose a reason for hiding this comment

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

@wbrgss awesome much-needed addition!!
no blocking issues for me so
💃after considering my comments 🎉

CONTRIBUTING.md Outdated

## Pull Request Guidelines

Using the [GitHub flow][] is encouraged when proposing contributions to this repository (i.e. creating a feature branch and submitting a PR on the master branch).
Copy link
Member

@cldougl cldougl Jul 24, 2018

Choose a reason for hiding this comment

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

let's change:

Using the [GitHub flow][] is encouraged

to
Use the [GitHub flow][]

I'd say this is more mandatory than encouraged 😆

Copy link
Member

Choose a reason for hiding this comment

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

then grammatically I think we'd want to change the last bit to:
(i.e. create a feature branch and submit a PR against the master branch).

CONTRIBUTING.md Outdated

If your company wishes to sponsor development of open source dash components, please [get in touch][].

### Notes
Copy link
Member

Choose a reason for hiding this comment

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

Not blocking-- but I would suggest removing the note and just working the link https://dev.w3.org/html5/html-author/#index-of-elements inline in the contribution section. That's a good comprehensive list so I find it important enough to be inline and we may consider adding a notes section in the future when we have more notes to add.

@wbrgss wbrgss merged commit 0217594 into master Jul 25, 2018
@wbrgss wbrgss deleted the wbrgss-contributing branch July 25, 2018 14:29
@wbrgss wbrgss restored the wbrgss-contributing branch July 25, 2018 16:04
@wbrgss wbrgss mentioned this pull request Jul 25, 2018
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.

3 participants