Dotts Trading Cards Version 2
How to Contribute to this Project
-
Clone the repository
git clone [email protected]:GuthrieW/dotts-trading-cards-version-2.git
. -
Read the Development section of the readme.
-
Pick an issue from the list on the project's GitHub and add yourself as an asignee.
-
Create a branch off of the
master
branch for your changes. -
Once your changes are finished and tested created a pull request. Send the link to your pull request to a code owner for review.
-
Post your pull request as a comment in its corresponding issue.
Development
Dependencies
- Before adding dependencies to the project please contact a code owner.
Branches
-
Branch names should not contain upper case characters, numerals, or spaces.
-
Branch names should correspond to a specific issue, i.e., readme-updates.
-
Branches are required to be reviewed by a code owner.
-
Direct pushes to the master branch are not permitted.
Running the Server Locally
The project uses Yarn Package Manager. Do not use NPM when developing this project. Yarn installation instructions can be found at on the Yarn Package Manager website.
Install dependencies.
yarn install
Run the development server.
yarn dev
Open http://localhost:3000 with your web browser to see the view the website.