Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 5.65 KB

README.md

File metadata and controls

97 lines (65 loc) · 5.65 KB
Raw

Open Source Project Template

Release Lint Contributor Covenant Maintainer

Before You Start

As much as possible, we have tried to provide enough tooling to get you up and running quickly and with a minimum of effort. This includes sane defaults for documentation; templates for bug reports, feature requests, and pull requests; and GitHub Actions that will automatically manage stale issues and pull requests. This latter defaults to labeling issues and pull requests as stale after 60 days of inactivity, and closing them after 7 additional days of inactivity. These defaults and more can be configured. For configuration options, please consult the documentation for the stale action.

In trying to keep this template as generic and reusable as possible, there are some things that were omitted out of necessity and others that need a little tweaking. Before you begin developing in earnest, there are a few changes that need to be made:

  • ✅ Select an appropriate license for your project. This can easily be achieved through the 'Add File' button on the GitHub UI, naming the file LICENSE, and selecting your desired license from the provided list.
  • Update the <License name> placeholder in this file to reflect the name of the license you selected above.
  • Replace [INSERT CONTACT METHOD] in CODE_OF_CONDUCT.md with a suitable communication channel.
  • Change references to org_name to the name of the org your repo belongs to (eg. wayfair-incubator):
  • Change references to repo_name to the name of your new repo:
  • Update the link to the contribution guidelines to point to your project:
  • Replace the <project name> placeholder with the name of your project:
  • Add names and contact information for actual project maintainers to MAINTAINERS.md.
  • Delete the content of CHANGELOG.md. We encourage you to keep a changelog.
  • Configure renovate.json for your project's language and tooling dependencies.
    • Note that the base renovate.json file included with this template inherits most of its configuration logic from Wayfair OSPO's recommended presets, hosted here. If your project does not require advanced dependency configuration, this may be sufficient for your needs.
    • 💡 To learn more about using and configuring Renovate, check out our wayfair.github.io article: Managing Project Dependencies.
  • Replace the generic content in this file with the relevant details about your project.
  • Acknowledge that some features like branch protection rules are only available when the repo is public.
  • 🚨 Delete this section of the README!

About The Project

Provide some information about what the project is/does.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm

    npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/org_name/repo_name.git

  2. Install NPM packages

    npm install

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation or the Wiki

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For detailed contributing guidelines, please see CONTRIBUTING.md

License

Distributed under the <License name> License. See LICENSE for more information.

Contact

Your Name - @twitter_handle - email

Project Link: https://github.com/org_name/repo_name

Acknowledgements

This template was adapted from https://github.com/othneildrew/Best-README-Template.