mirror of
https://github.com/mattintech/AndroidTestApp.git
synced 2026-07-11 10:41:54 +00:00
updating project docs
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Matt
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
23
README.md
23
README.md
@@ -161,10 +161,23 @@ This project uses:
|
||||
|
||||
Use responsibly and only on test devices or when specifically needed for development/testing purposes.
|
||||
|
||||
## License
|
||||
|
||||
This is a test application for development purposes.
|
||||
|
||||
## Contributing
|
||||
|
||||
This is a demonstration project. Feel free to fork and modify for your testing needs.
|
||||
Contributions are welcome! However, before investing significant time in a feature or change:
|
||||
|
||||
1. **Start a discussion first**: Open an issue or start a discussion in the project's Discussions tab to propose your idea
|
||||
2. **Wait for feedback**: Get confirmation that the change aligns with the project's goals
|
||||
3. **Fork and create a branch**: Work on your changes in a dedicated branch
|
||||
4. **Submit a Pull Request**: Include a clear description of the changes and reference any related issues
|
||||
|
||||
### Contribution Guidelines
|
||||
|
||||
- Follow the existing code style and conventions
|
||||
- Add tests for new functionality
|
||||
- Update documentation as needed
|
||||
- Ensure all tests pass before submitting
|
||||
- Keep commits focused and atomic
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
Reference in New Issue
Block a user