diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4acad5d3f..5a85b11fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,17 @@ # Contributing -## Setup for creating pull requests +## Creating pull requests - Fork this project - In your fork, create a branch, for example: `fix/camera-update` - Add your changes - Push and open a PR with your branch -## Testing my changes +## Testing changes -The metro bundler under `/example` is set up to use the libraries files under root. -Which means, when you change something within `javascript/components/UserLocation.js` -it will be reflected in any scene in example that uses that component. +The metro bundler under `/example` is set up to use the libraries files under root. Which means, when you change something within `javascript/components/UserLocation.js`, it will be reflected in any scene in `/example` that uses that component. + +The library is a combination of Typescript and Javascript, which gets compiled into `/lib` for consumption by the `/example` project. This should work fine, but if you have any difficulty with the example trying to read the files in `/javascript` (outside of `/lib`), as a last resort you can run `npm pack` in the root, and then in `/example`, run `npm install ../rnmapbox-maps-.tgz`. ## Best practices for PR's @@ -24,10 +24,4 @@ it will be reflected in any scene in example that uses that component. ## Documentation -Documentation is generated from code blocks and comments. -It will be auto-generated when you commit changes. -If any changes are generated from your edits, the changed files will need to be added using `git add` before attempting the commit again. -To manually generate the changes, run `npm run generate`. - -Notice, that changing the documentation in the individual .md within `/docs` will not suffice. -The correct way is the above described +Documentation is generated from code blocks and comments. It will be auto-generated when you commit changes. If any changes are generated from your edits, the changed files will need to be added using `git add` before attempting the commit again. To manually generate the changes, run `npm run generate`. \ No newline at end of file