|
| 1 | +--- |
| 2 | +title: Contributing |
| 3 | +order: 1 |
| 4 | +--- |
| 5 | + |
| 6 | +## Contributing |
| 7 | + |
| 8 | +We welcome contributions to NativePHP for Mobile! Whether it's bug fixes, new features, documentation improvements, or bug reports, every contribution helps make the project better. |
| 9 | + |
| 10 | +### How to Contribute |
| 11 | + |
| 12 | +1. **Fork the repository** on GitHub. |
| 13 | +2. **Clone your fork** locally: |
| 14 | + ```bash |
| 15 | + git clone git@github.com:your-username/mobile.git |
| 16 | + cd mobile |
| 17 | + ``` |
| 18 | +3. **Create a new branch** for your feature or fix: |
| 19 | + ```bash |
| 20 | + git checkout -b feature/my-new-feature |
| 21 | + ``` |
| 22 | +4. **Make your changes** and ensure all tests pass. |
| 23 | +5. **Commit your changes** with a clear, descriptive commit message. |
| 24 | +6. **Push your branch** to your fork: |
| 25 | + ```bash |
| 26 | + git push origin feature/my-new-feature |
| 27 | + ``` |
| 28 | +7. **Open a Pull Request** against the `main` branch of the NativePHP Mobile repository. |
| 29 | + |
| 30 | +### Pull Request Guidelines |
| 31 | + |
| 32 | +- Keep your changes focused. If you have multiple unrelated changes, please submit them as separate pull requests. |
| 33 | +- Write clear, descriptive commit messages. |
| 34 | +- Include tests for any new functionality. |
| 35 | +- Ensure all existing tests pass before submitting. |
| 36 | +- Update documentation if your changes affect the public API. |
| 37 | + |
| 38 | +### Reporting Bugs |
| 39 | + |
| 40 | +If you discover a bug, please [open an issue](https://github.com/NativePHP/mobile/issues) on GitHub. Include as much detail as possible: |
| 41 | + |
| 42 | +- A clear, descriptive title. |
| 43 | +- Steps to reproduce the issue. |
| 44 | +- Expected behavior vs. actual behavior. |
| 45 | +- Your environment details (OS, PHP version, Laravel version, etc.). |
| 46 | + |
| 47 | +### Security Vulnerabilities |
| 48 | + |
| 49 | +If you discover a security vulnerability, please **do not** open a public issue. Instead, please send an email to [security@nativephp.com](mailto:security@nativephp.com). All security vulnerabilities will be promptly addressed. |
| 50 | + |
| 51 | +## Code of Conduct |
| 52 | + |
| 53 | +The NativePHP community is dedicated to providing a welcoming and inclusive experience for everyone. We expect all participants to adhere to the following standards: |
| 54 | + |
| 55 | +### Our Pledge |
| 56 | + |
| 57 | +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. |
| 58 | + |
| 59 | +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. |
| 60 | + |
| 61 | +### Our Standards |
| 62 | + |
| 63 | +Examples of behavior that contributes to a positive environment: |
| 64 | + |
| 65 | +- Using welcoming and inclusive language |
| 66 | +- Being respectful of differing viewpoints and experiences |
| 67 | +- Gracefully accepting constructive criticism |
| 68 | +- Focusing on what is best for the community |
| 69 | +- Showing empathy towards other community members |
| 70 | + |
| 71 | +Examples of unacceptable behavior: |
| 72 | + |
| 73 | +- The use of sexualized language or imagery, and sexual attention or advances of any kind |
| 74 | +- Trolling, insulting or derogatory comments, and personal or political attacks |
| 75 | +- Public or private harassment |
| 76 | +- Publishing others' private information without explicit permission |
| 77 | +- Other conduct which could reasonably be considered inappropriate in a professional setting |
| 78 | + |
| 79 | +### Enforcement |
| 80 | + |
| 81 | +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at [conduct@nativephp.com](mailto:conduct@nativephp.com). All complaints will be reviewed and investigated promptly and fairly. |
| 82 | + |
| 83 | +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. |
0 commit comments