Badges: Services found in ServicesDB have the option to show build badges, offering quick links and build status information. When selecting badges, consider the most important statuses for your repo.
- Buildkite status badge: Available if your repo is for a service. Follow the help guide to get your badge code.
- Other badges (optional): Additional status badges relevant to your project can be found at http://shields.io/.
- Custom badges: Custom badges can be added using small image icons of your choice. Popular custom badges include Shipit and Splunk.
About this repo | Projects & Roadmap | Commands | How to use this repo | Contribute to this repo | Technical details
Introduction: Main goal of the repo, and why it's important. 2-3 short paragraphs.
| Current status | Current project status. Maintenance, deprecated, beta, etc. Include link to roadmap |
| Owner | Who maintains the project? Link to vault team(s) and slack channels. Break into new section if extensive. |
| Help | Where to go for help or ask questions. Link any relevant help channels, playbooks or resources. Break into new section if extensive. |
Guiding principles (optional): What everlasting principles drive the design of this project? If related to a specific project, this could be your success criteria, or design goals.
Link to projects and roadmaps where relevant. A high level overview of the future of the repo. This section should guide the reader towards understanding what features currently exist and what features are planned.
| Feature name | Feature description |
|---|---|
| Feature | Example description of the feature (link to relevant project if applicable). Marked as Done, ongoing or planned. |
See all commands in the dev.yml file
This repo requires the following:
- MySQL
- Ruby
- Clone the repo with
dev clone PS - Run
dev upto install dependencies - Start the development server via
dev server - Open the server with
Ctrl+T
- Run tests with
dev test
Read the GETTING STARTED document for help developing with the Shopify Rails Stack.
Any additional details for contributors. This differs from the getting started section in that its purpose is development and not just use. Can include additional steps such as:
- What is necessary for PRs (formatting, pings)
- Architecture and style guides
Before removing this section, consider whether a new hire reading this README for the first time would be able to understand how to contribute to the repo. If the content exceeds 3 paragraphs or includes large tables/graphs, break out into a CONTRIBUTING.md file, and link to it.
This section can be used to outline specific technical info for the repo. Before adding content to this section, consider whether the README is the right place for your content. The Vault page on context sharing can help you determine the right place for your content, and link back to the README.