Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 2.28 KB
Raw

Contribution Guide for Wallet Sample

Welcome, Contributors!

🌟 Thank you for considering contributing to Wallet Sample! This project aims to make the shift from XML-based Android development to Jetpack Compose as seamless and educational as possible. Your contributions can help make this a top resource for developers embarking on this modern UI toolkit journey.

How to Contribute

1. Understanding the Project Objective

  • Familiarize yourself with Jetpack Compose and its advantages over traditional XML-based development.
  • Ensure your contributions align with the goal of simplifying the learning curve for beginners.

2. Setting Up the Environment

  • Clone the repository: git clone https://github.com/your-repo-link
  • Set up your development environment with Android Studio.

3. Contributing Code

  • Browse the issues or create a new one if you have a suggestion or bug report.
  • Fork the repository and create a new branch for your feature or fix.
  • Write clean, well-documented code. Follow existing coding conventions and styles.
  • Ensure your code is easily understandable for beginners.
  • Test your changes thoroughly.

4. Submitting a Pull Request

  • Provide a clear description of the problem and your solution.
  • Reference any relevant issue numbers.
  • Await review from the project maintainers.
  • Be open to suggestions and constructive feedback.

5. Non-Code Contributions

  • Update or improve documentation.
  • Write tutorials or create examples that help demonstrate the use of Jetpack Compose.
  • Report bugs and suggest enhancements.

Community Guidelines

  • Respect: Foster a welcoming and inclusive environment. Respect all contributors regardless of their experience level.
  • Collaboration: Work together with the community. Share ideas and solutions.
  • Quality: Aim for excellence. Your contributions should not only work but also maintain high standards in terms of quality and usability.

License

By contributing to Wallet Sample, you agree that your contributions will be licensed under its MIT License.

🚀 Your involvement is crucial in making Wallet Sample an exemplary project for learning and transitioning to Jetpack Compose. Let's build something amazing together!