- Further Documentation
- System Overview
- Installation
- Running Locally
- Testing _ Automated Testing _ Manual testing
- Script cheat sheet
- Built With
- Linting
- Deploying
- Contributing Rules
- Common Questions
Include any other relevant documentation in this section.
- More in-depth overview of the system, what this is trying to accomplish and how it achieves its goal.
- Keep it concise, write this section like the first paragraph of a blog post, what is the point of this repo?
- Perhaps label some of the core tech used in the repo and link to the external websites/documentation
- Step-by-step guide on installation
- Step-by-step guide of setting up locally
- List scripts used in the repo and a description of what they do
- Example:
npm run build:= Generatesdistfolder with changes made inlib
- What CI do the test run on?
- Link to CI website/status page
- What testing framework is used?
- How are the tests structured in this repo? Is there a strict writing style to follow?
- Step-by-step to run all automated testing.
- What are some of the commands I need to know when running test in my local environment?
- Any tips on running singular tests or groups of tests at once in this repo?
- Link to external regression checklist document
- If anything particular is setup for this repo, describe how you would manually test a feature branch before going to production
- What frameworks are used? Links to framework API docs.
- Essential node modules used, links to documentation/repo.
- How to I lint specific file types?
- Do these run via git hooks
- Link to linting rules
- How do deploys work for new pull requests?
- Steps on how to get a feature branch merged and deployed into production environment
- Link to HX-culture documentation on contribution
- Any specific rules for this repo?
- Frequently asked questions that will help engineers
- Link/State which stretch/guild would be best to chat with to answer questions not listed here