We love pull requests from everyone. We expect contributers to follow our Code of Conduct while submitting code or comments.
- Clone the repo locally and run
yarnto install dependencies from npm.
git clone git@github.com:ikuseiGmbH/smart-village-app-app.git
cd smart-village-app-app
yarn-
To start the package manager and expo environment, run
yarn start. -
To run the app in a local iOS simulator, run
yarn ios. -
Check if the test suite is running properly with
yarn test. -
Develop your part of the mobile app, create tests and run them.
-
Lint your code with
yarn lint. -
Push to your repo and submit a pull request.
Thanks for your contribution. It means a lot to us.
Please pay attention to detailed and meaningful commit messages.
A good summary, thx to: https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/
- Specify the type of commit:
- feat: The new feature you're adding to a particular application
- fix: A bug fix
- style: Feature and updates related to styling
- refactor: Refactoring a specific section of the codebase
- test: Everything related to testing
- docs: Everything related to documentation
- chore: Regular code maintenance.
- Separate the subject from the body with a blank line
- Your commit message should not contain any whitespace errors
- Remove unnecessary punctuation marks
- Do not end the subject line with a period
- Capitalize the subject line and each paragraph
- Use the imperative mood in the subject line
- Use the body to explain what changes you have made and why you made them.
- Do not assume the reviewer understands what the original problem was, ensure you add it.
- Do not think your code is self-explanatory
- Follow existing commit conventions, for example: https://www.conventionalcommits.org/en/v1.0.0/