nitaliano / react-native-mapbox-gl

A Mapbox GL react native module for creating custom maps
Other
2.16k stars 697 forks source link

Ways of Working #1339

Open kristfal opened 6 years ago

kristfal commented 6 years ago

Hey,

as this project becomes more community driven than before, we should define some ways of working to maintain/improve the quality and development speed of the repo.

As an OS project, this repo lacks some aspects that may/will make the lives of maintainers easier. These include (but may not be limited to):

1) Issue template:

a) To keep questions out of Github, the template should link to gitter and stackoverflow b) We need users to specify version of react-native-mapbox-gl and RN

2) CI/CD:

a) We should run unit tests on all PRs and master b) We should run E2E tests on the example app (we have a quite good experience using Detox)

3) Coding styles:

a) We now use Prettier and ESLint. Is there anything equivalent for Java and Obj-C that we should use?

To maintainers: Any thoughts on this and other aspects of the repo?

samdelacruz commented 6 years ago

All sounds reasonable, however I tend to disagree with 1a. Questions being raised in GitHub are an indication of a need for better documentation - and answering the questions on the issue provides an easy way for subsequent users to find answers more quickly than waiting for a response in gitter. They can be a prompt for raising documentation issues. IMO it's better to keep information in one place, rather than scattered around the web in different services.

nitaliano commented 6 years ago
onitzschke commented 5 years ago

I totally agree with you.