Skip to content

Latest commit

 

History

History
131 lines (88 loc) · 10.5 KB

CONTRIBUTING.md

File metadata and controls

131 lines (88 loc) · 10.5 KB
Raw

Contributing to NewsKit

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's README
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behaviour to [email protected].

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Types of Contribution

I Have a Question or Enhancement Idea

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues and Discussions that might help you. In case you have found a suitable ticket and still need clarification, you can write your question in it. It is also advisable to search News Corp Slack (eg #newskit channel) to see if the issue has be raised before. If a question does evolve, and manifest as a bug/feature request, it can be moved to issues.

If you then still feel the need to ask a question and need clarification, we recommend you:

  • Go to the Discussion page
  • Select General for general questions or Ideas for enhancement ideas (but for Support, it is better to open an issue, see Reporting Bugs)
  • Provide as much context as you can.
  • Provide the name of your team/brand.

Suggesting Enhancements

Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, adding the component to your team's library might be better.

From the Discussion page, click Getting Started against Ideas.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • You may want to include screenshots/recordings/animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most CONTRIBUTING.md users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

We will then investigate the issue and get back to you.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Check if the bug has been fixed in the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search News Corp Slack (eg #newskit channel) to see if other teams have reported similar issues
  • Collect information about the bug:
  • Console errors or stack trace
  • OS, Platform and Version (Windows, Linux, macOS, x86, ARM) you are using
  • Type and version of the browser
  • Possibly your input and the output
  • Can you reliably reproduce the issue? Does it affect all browsers?
  • If you can provide a link to your site, or a code sandbox, to demonstrate the issue, then that is a big help. You can use this NewsKit 7 template for code sandbox.

How to Submit a Good Bug Report

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [email protected].

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.
  • Provide the name of your team/brand.

Once it's filed:

  • By default, issues will have the triage which alerts the project team that there is a new issue that needs analysis.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and label the issue as needs additional info. Bugs marked needs additional info will not be addressed until they are reproduced.
  • If the issue is accepted, the triage label will be removed and the issues will be prioritised accordingly.

Your First Code Contribution

  • Look out for issues labelled good first issue as these have been pre-approved by the project team and represent an opportunity to increase your contribution experience.
  • Read through the Pre-requisites, Getting Started and Styleguides sections in the README.

Improving The Documentation

  • There is always scope for adding team-specific examples to Storybook or the Next.js-based docs site, to help your team members see how to apply NewsKit in your projects. Remember that the Storybook Theme Dropdown can be used to better preview how the components will look on your site.

Submitting a Contribution

Opening a Pull Request

Before making any changes, make sure you have permission to push to the NewsKit repository. You will need to request access to this group to become a contributor.

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill in the sections on the PR template and label it as "Ready to Review" when you have completed all changes. This helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Once you submit your PR, a project team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Merging a Pull Request and Releasing it

Merging to main branch and releasing will need to be done by a member of the project team. Once your PR is merged, your contributions will be publicly visible, as NewsKit is open source. You will not be able to use the change in your team's project until a NewsKit release has taken place though. Let the project team know how soon you need the change; otherwise you may be waiting 1-14 days for a routine release to take place.

The Project Team

The NewsKit core team is a Scrum-sized team based in London and Sofia and includes designers and engineers. Keep an eye on the #newskit channel in Slack for announcements about new versions. Questions can be asked on that channel or one of the team-specific support channels.