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

chore(803): improve contribution guidance for developers #844

Merged
merged 9 commits into from
Apr 24, 2023

Conversation

JohnTParsons
Copy link
Collaborator

@JohnTParsons JohnTParsons commented Apr 20, 2023

closes #803

What

  1. Background - we are welcoming external contributors to newskit
  2. What did you do - add CONTRIBUTING.md and edit README.md
  3. What does the reviewers should expect - preview the markdown changes by going to
    https://github.com/newscorp-ghfb/NewsKit/blob/chore/803-contribution-guidance/CONTRIBUTING.md
    and
    https://github.com/newscorp-ghfb/NewsKit/tree/chore/803-contribution-guidance#readme (the new link to it in README.md)

I have done:

  • Written unit tests against changes
  • Written functional tests against the component and/or NewsKit site
  • Updated relevant documentation

I have tested manually:

  • The feature's functionality is working as expected on Chrome, Firefox, Safari and Edge
  • The screen reader reads and flows through the elements as expected.
  • There are no new errors in the browser console coming from this PR.
  • When visual test is not added, it renders correctly on different browsers and mobile viewports (Safari, Firefox, small mobile viewport, tablet)
  • The Playground feature is working as expected

Before:

After:

Who should review this PR:

How to test:

@pp-serviceaccount
Copy link
Collaborator

@JohnTParsons JohnTParsons marked this pull request as ready for review April 21, 2023 08:39
@JohnTParsons JohnTParsons added the ready for review Please assist in getting this reviewed label Apr 21, 2023
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated
Comment on lines 38 to 40
If you then still feel the need to ask a question and need clarification, we recommend the following:

* Open an [Issue](https://github.com/newscorp-ghfb/NewsKit/issues/new/choose) if it is clear what the issue is; otherwise create a new [Discussion](https://github.com/newscorp-ghfb/NewsKit/discussions).
Copy link
Contributor

@Vanals Vanals Apr 21, 2023

Choose a reason for hiding this comment

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

As above!

Also I think they can open issues even if is not clear to them what the problem is, as far as is a bug for instance it is fine for them to open an Issue IMO. So Again I would explain the two path Question and Bug/Feature separately. from a question. Feels a bit mixed now

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Have now combined the information from the original Ask a Question and Suggesting Enhancements sections to reduce the repetition

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@jps
Copy link
Contributor

jps commented Apr 21, 2023

looking good! 💯

@JohnTParsons JohnTParsons merged commit c69689d into main Apr 24, 2023
@JohnTParsons JohnTParsons deleted the chore/803-contribution-guidance branch April 24, 2023 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for review Please assist in getting this reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve contribution guidance for developers
4 participants