Loading...
Contributions are always welcome, no matter how large or small!
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the code of conduct.
git clone https://github.com/Lumine-UI/lumine-ui.git
cd lumine-ui
npm install
npm run prepare
npm pack
Run the following commands by replacing x.y.z with the current version of the tgz file generated. For example, lumine-ui-0.1.0.tgz.
Go to the example directory
cd example
Install the package
npm install ../lumine-ui-x.y.z.tgz
Go to server director
cd server
Install the dependencies
npm install
Run the development server
npm run dev
The server will start on http://localhost:5000/
Go to lumine-ui directory
cd ..
To start the packager:
yarn example start
To run the example app on Android:
yarn example android
To run the example app on iOS:
yarn example ios
To run the example app on Web:
yarn example web
Make sure your code passes TypeScript and ESLint. Run the following to verify:
yarn typescript yarn lint
To fix formatting errors, run the following:
yarn lint --fix
Remember to add tests for your change if possible. Run the unit tests by:
yarn test
If you want to use lumine for navigation, you need to install react-native-screens and react-native-safe-area-context. Run the following command in the example directory:
npx expo install react-native-screens react-native-safe-area-context
We follow the conventional commits specification for our commit messages:
fix: bug fixes, e.g. fix crash due to deprecated method.feat: new features, e.g. add new method to the module.refactor: code refactor, e.g. migrate from class components to hooks.docs: changes into documentation, e.g. add usage example for the module..test: adding or updating tests, e.g. add integration tests using detox.chore: tooling changes, e.g. change CI config.Our pre-commit hooks verify that your commit message matches this format when committing.
We use TypeScript for type checking, ESLint with Prettier for linting and formatting the code, and Jest for testing.
Our pre-commit hooks verify that the linter and tests pass when committing.
We use release-it to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
To publish new versions, run the following:
yarn release
The package.json file contains various scripts for common tasks:
yarn bootstrap: setup project by installing all dependencies and pods.yarn typescript: type-check files with TypeScript.yarn lint: lint files with ESLint.yarn test: run unit tests with Jest.yarn example start: start the Metro server for the example app.yarn example android: run the example app on Android.yarn example ios: run the example app on iOS.Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.
When you're sending a pull request: