Skip to content

Update contributing doc #1929

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.

Sign up for GitHub

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

Merged
naftalibeder merged 1 commit into from
May 24, 2022
Merged

Update contributing doc #1929

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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-<version>.tgz`.

## Best practices for PR's

Expand All @@ -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 <COMPONENT>.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`.