Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write a getting starting guide #43

Open
voces opened this issue Feb 27, 2020 · 1 comment
Open

Write a getting starting guide #43

voces opened this issue Feb 27, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@voces
Copy link
Owner

voces commented Feb 27, 2020

  1. Cloning
  2. Branching
  3. npm install
  4. Import for typing
  5. Testing (start)
  6. Testing (local)
  7. Testing (jest/w3api)
  8. Making a PR
@voces voces added the documentation Improvements or additions to documentation label Feb 27, 2020
@voces voces self-assigned this Feb 27, 2020
@voces
Copy link
Owner Author

voces commented Feb 28, 2020

A draft:

# Getting started
1. Fork the Fixus repo <insert image>
2. Clone your repo using `git clone [email protected]:myusername/fixus.git`
3. Create a branch `git checkout -b myusername/coins`
4. Install dependencies `npm install`
5. Make your changes. See Contributing code and Contributing WE.
6. Test the map to make sure you changes work.
7. Consider writing actual jest tests.

@voces voces removed their assignment Mar 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant