Skip to content

Commit 03cf43a

Browse files
authored
docs: move development related info to the wiki (#797)
1 parent 80b4fe9 commit 03cf43a

File tree

2 files changed

+5
-149
lines changed

2 files changed

+5
-149
lines changed

CONTRIBUTING.md

+5-65
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,32 @@
11
# Contributing
22

33
Thank you for your interest in contributing! Please feel free to put up a PR for any issue or feature request.
4+
45
Even if you have little to no experience with React Native, we'll be more than happy to help :)
56

67
## Gitter
78

89
Please don't hesitate to join our [gitter](https://gitter.im/git-point)! Technical points of discussion, general questions and suggestions or anything at all - we would love to chat about it.
910

10-
## Issues
11-
12-
### Creating issues
11+
## Reporting issues & features requests
1312

14-
If you notice any bugs in the app, see some code that can be improved, or have features you would like to be added, please create an issue!
13+
If you notice any bugs in the app, see some code that can be improved, or have features you would like to be added, please create a [bug report](https://github.com/gitpoint/git-point/issues/new?template=BUG_REPORT.md) or a [feature request](https://github.com/gitpoint/git-point/issues/new?template=FEATURE_REQUEST.md)!
1514

1615
If you want to open a PR that fixes a bug or adds a feature, then we can't thank you enough! It is definitely appreciated if an issue has been created before-hand so it can be discussed first.
1716

18-
## Unit Tests
19-
Please refer to [Tests Guide](TESTS.md)
20-
21-
### Working on issues
17+
## Working on issues
2218

2319
Please feel free to take on any issue that's currently open. Feel free to resolve any issue that you would enjoy working on even if it happens to be a low priority.
2420

25-
## Setup
26-
27-
1. Fork the repo
28-
2. Clone your fork
29-
3. Make a branch for your feature or bug fix
30-
4. Follow the [React Native Guide](https://facebook.github.io/react-native/docs/getting-started.html) for learning how to get started with building a project with native iOS code (a Mac is required)
31-
5. The `CLIENT_ID` and `CLIENT_SECRET` in `api/index.js` are for development purposes and do not represent the actual application keys. Feel free to use them or use a new set of keys by creating an [OAuth application](https://github.com/settings/applications/new) of your own.
32-
- Set the "Authorization callback URL" to `gitpoint://welcome`.
33-
6. `yarn` to install dependencies
34-
7. `yarn run link` to link react-native dependencies
35-
8. Use one of the following commands depending on the target platform:
36-
- `yarn start:ios` to start the packager and run the app in the iOS simulator (`yarn start:ios:logger` will boot the application with [redux-logger](https://github.com/evgenyrodionov/redux-logger))
37-
- `yarn start:android` to start the packager and run the app in the the Android device/emulator (`yarn start:android:logger` will boot the application with [redux-logger](https://github.com/evgenyrodionov/redux-logger))
38-
9. Work your magic! Run the app on an [actual device](https://facebook.github.io/react-native/docs/running-on-device.html) as well to test your feature/fix.
39-
10. Add yourself to the [contributor's list](https://github.com/gitpoint/git-point/blob/master/CONTRIBUTORS.md) by doing `yarn contributors:add`
40-
11. Commit your changes with a message following the [Angular commit conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
41-
- [Commitizen](https://github.com/commitizen/cz-cli) works with this repo. You can install the CLI globally (`yarn global add commitizen`) where you can then create formatted commit messages with `git cz` by filling out a few required fields
42-
12. Push your branch to your fork
43-
13. Create a pull request from your branch on your fork to `master` on this repo
44-
14. If your PR changes any UI or styling, **add screenshots** of all the components and screens you've modified **before and after** your changes. We can't approve your PR unless you have those screenshots _and_ we've tested it locally on our simulators/device
45-
15. Have your branch get merged in! :star2:
46-
47-
If you experience a problem at any point, please don't hesitate to file an issue or send me a message!
48-
49-
## Translations
50-
51-
Translation contributions are always welcome! If you happen to speak/read any language fluently and feel comfortable translating all the strings, please don't hesitate to open an issue to suggest including it and/or submitting a PR to include it. Here's how to add a new language:
52-
53-
1. In the `locales` directory we just need to add a new file for a new language. We can just copy the `en.js` file (to _es.js_ for Spanish for example) and swap out all the English text for that specific language.
54-
2. We'll need to then export that newly added file as well [here](https://github.com/gitpoint/git-point/blob/master/src/locale/languages/index.js).
55-
3. Next, we'll need to add the new lang object [here](https://github.com/gitpoint/git-point/blob/023c7f4ae52694f75a1bc9748b072f6f66687b0a/src/locale/index.js#L7).
56-
4. And lastly, in order for the language to be displayed in the options screen, we'll need to add a [two-letter code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) in lowercase (for example: _es_ for Spanish) and the native language name (for example: _España_ for Spanish) to the [language-settings.js](https://github.com/gitpoint/git-point/blob/master/src/auth/screens/language-settings.js) file. Please make sure the two-letter code matches the code used for the `moment` library to allow for date/time compatibility (you can view the list [here](https://github.com/moment/moment/tree/develop/locale)).
57-
5. Test out selecting your new translation and if it all looks good, submit that PR in! :smile:
58-
59-
## Styled Components
60-
61-
We're moving from React Native's styles implementation and we are start using [Styled Components](https://www.styled-components.com/) This will let us write the styles for the app in a more _css way_. If you like to know why we're taking this decision you can read [This issue](https://github.com/gitpoint/git-point/issues/480)
62-
63-
## Troubleshooting
64-
65-
If you happen to see an error like below when you try to run the application:
66-
67-
```
68-
error: bundling: UnableToResolveError: Unable to resolve module `config` from `/Users/frankdilo/projects/git-point/App.js`: Module does not exist in the module map or in these directories:
69-
/Users/{user}/projects/git-point/node_modules
70-
```
71-
72-
1. Please try running `yarn start -- --reset-cache` and then `yarn run ios` in a separate terminal window
73-
2. If that doesn't solve it, try the following commands:
74-
- Clear watchman watches: `watchman watch-del-all`.
75-
- Delete the `node_modules` folder: `rm -rf node_modules && yarn`.
76-
- Reset packager cache: `rm -fr $TMPDIR/react-*` or `yarn start -- --reset-cache`.
77-
3. If that sill doesn't solve it, please open an issue so we can figure out why it's not working for you
78-
21+
In order to get started with GitPoint development, check out [our Wiki](https://github.com/gitpoint/git-point/wiki)
7922

8023
## Financial contributions
8124

8225
We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/git-point).
8326
Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
8427

85-
8628
## Credits
8729

88-
8930
### Contributors
9031

9132
Checkout all the awesome people who have contributed [here](./CONTRIBUTORS.md).
@@ -96,7 +37,6 @@ Thank you to all our backers! [[Become a backer](https://opencollective.com/git-
9637

9738
<a href="https://opencollective.com/git-point#backers" target="_blank"><img src="https://opencollective.com/git-point/backers.svg?width=890"></a>
9839

99-
10040
### Sponsors
10141

10242
Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/git-point#sponsor))

TESTS.md

-84
This file was deleted.

0 commit comments

Comments
 (0)