-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a2ace47
commit fe8c855
Showing
3 changed files
with
320 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by community members include: | ||
|
||
- The use of sexualized language or unwanted sexual attention | ||
- Trolling, insulting/derogatory comments, and personal attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html), version 2.1, available at [https://www.contributor-covenant.org/](https://www.contributor-covenant.org/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
# Contributing to Expo React Native Paper | ||
|
||
We are grateful for your interest in contributing to the **Expo React Native Paper** project! Contributions are essential for the project's growth and success. This document outlines the guidelines for contributing to ensure a smooth and collaborative development process. | ||
|
||
## Code of Conduct | ||
|
||
Please familiarize yourself with and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Here, we aim to foster an inclusive and respectful community for everyone. | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
Ensure you have the following prerequisites installed on your machine: | ||
|
||
- [Node.js](https://nodejs.org/) | ||
- [npm](https://www.npmjs.com/) | ||
|
||
### Setting Up Your Development Environment | ||
|
||
1. **Fork the Repository** | ||
|
||
Fork the `expo-react-native-paper` repository from [GitHub](https://github.com/youzarsiph/expo-react-native-paper). | ||
|
||
2. **Clone Your Fork** | ||
|
||
```bash | ||
git clone https://github.com/your-username/expo-react-native-paper.git | ||
cd expo-react-native-paper | ||
``` | ||
|
||
3. **Customize the Project** | ||
|
||
Update the application name in `package.json`: | ||
|
||
```jsonc | ||
{ | ||
"name": "your-app-name", | ||
... | ||
} | ||
``` | ||
|
||
4. **Install Dependencies** | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
5. **Start the Development Server** | ||
|
||
```bash | ||
npm start | ||
``` | ||
|
||
## Contribution Guidelines | ||
|
||
### Branching Strategy | ||
|
||
We use a [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) branching strategy. All contributions should be made in new branches based off the **develop** branch. | ||
|
||
1. **Create a New Branch** | ||
|
||
```bash | ||
git checkout -b feature/AmazingFeature develop | ||
``` | ||
|
||
### Commit Guidelines | ||
|
||
- Use clear and descriptive commit messages. | ||
- Refer to issues in your commit messages using `#issueNumber`. | ||
- Follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for better readability and maintainability. | ||
|
||
```markdown | ||
feat: add navigation using Expo Router | ||
fix: resolve issue with theme initialization #12 | ||
docs: update README with contribution steps | ||
``` | ||
|
||
### Pull Request Guidelines | ||
|
||
1. **Ensure Your Branch is Up-to-Date** | ||
|
||
Merge the latest changes from the **develop** branch before submitting a pull request. | ||
|
||
```bash | ||
git checkout develop | ||
git pull origin develop | ||
git checkout feature/AmazingFeature | ||
git merge develop | ||
``` | ||
|
||
2. **Run Linters and Tests** | ||
|
||
Ensure your changes pass all automated checks. | ||
|
||
```bash | ||
npm run lint | ||
npm test | ||
``` | ||
|
||
3. **Open a Pull Request** | ||
|
||
- Open a pull request in the original repository with a clear title and description. | ||
- Reference any issues your pull request addresses with `#issueNumber`. | ||
- Include a summary of your changes and any related information. | ||
|
||
## Code Quality and Standards | ||
|
||
We strictly adhere to code quality and coding standards to maintain a high-quality codebase. | ||
|
||
- **CodeQL**: Security scans for identifying vulnerabilities. | ||
- **ESLint**: JavaScript linting for consistency. | ||
- **Prettier**: Code formatting for uniformity. | ||
|
||
Ensure your code adheres to these standards before submitting a pull request. | ||
|
||
## Reporting Bugs | ||
|
||
If you encounter a bug, please report it using the [issue tracker](https://github.com/youzarsiph/expo-react-native-paper/issues). | ||
|
||
- **Describe the bug in detail**. | ||
- **Provide steps to reproduce the bug**. | ||
- **Include relevant error messages and screenshots**. | ||
- **Indicate your operating system, device, and version**. | ||
|
||
## Suggesting Features | ||
|
||
If you have a new idea or feature request, please create a new issue on the [issue tracker](https://github.com/youzarsiph/expo-react-native-paper/issues). | ||
|
||
- **Provide a clear and concise description of the feature**. | ||
- **Explain the benefits and how it fits into the project**. | ||
- **Discuss any potential concerns or drawbacks**. | ||
|
||
## Contact | ||
|
||
For any questions or feedback, feel free to reach out to the project maintainers: | ||
|
||
- [Youzarsiph](https://github.com/youzarsiph) | ||
|
||
Thank you for your contributions! We are excited to see what you bring to the project. |
Oops, something went wrong.