You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To contribute to hackd, clone/fork the repository, make changes and open a PR with your changes. Any type of change is welcomed, including bug fixes, new features, documentation or tests.
4
+
5
+
Opening issues for bugs, features or anything else is also welcomed.
6
+
7
+
If you are implementing a new feature, or modifying styles, please replace/add screenshot(s) to the [README](README.md).
8
+
9
+
### Prettier
10
+
11
+
[Prettier](https://github.com/prettier/prettier) is used to keep a consistent code style across the project. Before committing, run `npm run prettier` which will transform your code to fit the projects style.
12
+
13
+
### ESLint
14
+
15
+
[ESLint](https://github.com/eslint/eslint) is used for code linting inside your IDE/text editor. If you don't have ESLint installed in your editor, you should install it - [https://eslint.org/docs/user-guide/integrations](https://eslint.org/docs/user-guide/integrations).
16
+
17
+
To find any errors or warnings, either view them in your editor once you've installed the right package, or run `npm run eslint`. Not all errors/warnings can be fixed, and some will be picked up by prettier, so don't worry if you can't fix them.
18
+
19
+
### Lock Files
20
+
21
+
All lock files (`package-lock.json`, `yarn.lock`) should be committed.
22
+
23
+
### Dependencies
24
+
25
+
Try to keep dependencies to a minimum where possible. If you are pulling a whole library for just one function, try to implement that function as a helper method.
26
+
27
+
### Testing
28
+
29
+
[Jest](https://github.com/facebook/jest) is used for testing. Once you've made changes, writing a test case helps to catch any bugs. Feel free to open a PR that just includes more tests.
30
+
31
+
### Setup
32
+
33
+
Follow the instructions in the [README](README.md) to get setup. Once hackd is running in the iOS simulator, you can enable debugging and view redux-logger logs in the console.
0 commit comments