Mentorship System is an application that allows women in tech to mentor each other, on career development topics, through 1:1 relations for a certain period.
This is the Android client for the Mentorship System.
To setup the project locally read these wiki pages and follow the instructions:
Please read our Contributing guidelines, Code of Conduct and Reporting Guidelines
Please follow our Commit Message Style Guide while sending PRs.
Please follow Kotlin official docs for Coding Conventions to maintain a consistent code style in the repository.
Thanks goes to these people (emoji key):
Isabel Costa π» π§ β οΈ π π¨ |
Vaishnavi Joshi π§ π¨ π π |
Kapil Bansal π§ β οΈ π π |
Aditya Kurkure π» β οΈ π π |
Gauri V. Nair π§ π |
This project follows the all-contributors specification. Contributions of any kind welcome!
To run the existing UI tests follow the steps given below:
./gradlew clean build connectedAndroidTest --stacktrace
gradlew clean build connectedAndroidTest --stacktrace
./mentorship-android/app/build/reports/androidTests/connected/index.html
./mentorship-android/app/build/reports/androidTests/connected/index.html
will show all the testsuites that have passed as well as failed.org.anitab.mentorship.LoginActivityTest.html
will contain the results of all the tests run under that particular testsuite.index.html
report.To learn more about the project's goals and progress, check out Mentorship Roadmap.
To learn more about this app you can look at this project's wiki.
Check out the design history at User Interface Design.
Our tech stack includes:
The repository has the following permanent branches:
master This contains the code which has been released.
develop This contains the latest code. All the contributing PRs must be sent to this branch. When we want to release the next version of the app, this branch is merged into the master
branch.
apk This branch contains the apks for the code in the develop branch. The apks are automatically updated when a commit is pushed to develop
branch.
You can reach our community at AnitaB.org Open Source Zulip.
We use #mentorship-system stream on Zulip to discuss this project and interact with the community. If you're interested in contributing to this project, join us there!
Mentorship System is licensed under the GNU General Public License v3.0. Learn more about it in the LICENSE file.