We appreciate your contribution and hope that this document helps you along the way. If you have any questions or problems, don't hesitate to file an issue.
Note: These guidelines are for contributing to the theme itself, if you are looking for help running a Doctocat site for another project locally, check out the Local Development docs in the Usage section.
Run the following commands to begin local development:
# Clone the repositorygit clone https://github.com/primer/doctocat.gitcd doctocat# Install the dependenciesyarn# Start the development server for the documentation siteyarn workspace docs develop# Navigate to http://localhost:8000 in your browser
.├── theme/├── docs/├── package.json└── now.json
theme/: This directory contains the code for the Gatsby Theme and is what gets published to npm.
docs/: This directory contains the code for the documentation site for Doctocat. The documentation site can also be used to test changes to the theme locally.
package.json: This file defines the Yarn Workspaces for the project and is not meant to be published.
now.json: This file configures the deployment of the documentation site. Check out the now.json docs for more information.
yarn workspace docs <script-name>
Starts Gatsby's hot-reloading development environment on http://localhost:8000. This is likely the only script you will run manually.
Builds the site for deployment and places the output in
Guidelines for bug reports:
A good bug report shouldn't leave others needing to chase you down for more information. Please try to be as detailed as possible in your report.
All these details will help people to fix any potential bugs.
Short and descriptive example bug report title
A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.
- This is the first step
- This is the second step
- Further steps, etc.
- Attach screenshots, etc.
Any other information you want to share that is relevant to the issue being reported.
Feature requests are welcome. But take a moment to 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. Please provide as much detail and context as possible.
Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).
Follow this process if you'd like your work considered for inclusion in the project:
Fork the project, clone your fork, and configure the remotes:
# Clone your fork of the repositorygit clone https://github.com/<your-username>/doctocat# Navigate to the newly cloned directorycd doctocat# Assign the original repo to a remote called "upstream"git remote add upstream https://github.com/primer/doctocat
If you cloned a while ago, get the latest changes from upstream:
git checkout mastergit pull upstream master
Create a new topic branch (off of the
master branch) to contain your feature, change, or fix:
git checkout -b <topic-branch-name>
Install the dependencies:
Start Gatsby's hot-reloading development environment:
yarn workspace docs develop# The documentation site will now be accessible from http://localhost:8000
Commit your changes in logical chunks. You can use Git's interactive rebase feature to tidy up your commits before making them public.
Locally merge (or rebase) the upstream development branch into your topic branch:
git pull [--rebase] upstream master
Push your topic branch up to your fork:
git push origin <topic-branch-name>
Open a Pull Request with a clear title and description.