Skip to content

Commit

Permalink
Add 'Before you begin' section (#8)
Browse files Browse the repository at this point in the history
Contains a listing of some of the features offered, links to documentation for the relevant GitHub Actions, and a list of placeholder content to be replaced.
  • Loading branch information
jdhmtl authored Jul 21, 2021
1 parent 672ad4c commit fefa2fc
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,30 @@

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md)

## 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](https://github.com/features/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](.github/workflows/stale.yml) and more can be configured. For configuration options, please consult the documentation for the [stale action](https://github.com/actions/stale).

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
- [ ] Change references to `org_name` to the name of the org your repo belongs to (eg. `wayfair-incubator`)
- [ ] In [`README.md`](README.md)
- [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md)
- [ ] Change references to `repo_name` to the name of your new repo
- [ ] In [`README.md`](README.md)
- [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md)
- [ ] Update the link to the contribution guidelines to point to your project
- [ ] In [`.github/ISSUE_TEMPLATE/BUG_REPORT.md`](.github/ISSUE_TEMPLATE/BUG_REPORT.md)
- [ ] In [`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md)
- [ ] Replace the `<project name>` placeholder with the name of your project
- [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md)
- [ ] In [`SECURITY.md`](SECURITY.md)
- [ ] Add names and contact information for actual project maintainers to [`MAINTAINERS.md`](MAINTAINERS.md)
- [ ] Replace the generic content in this file with the relevant details about your project
- [ ] Delete this section of the README

## About The Project

Provide some information about what the project is/does.
Expand Down

0 comments on commit fefa2fc

Please sign in to comment.