Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on the deployed Homiletics App in both the App Store and the Play Store.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- The GitHub flow
- Collaborating with pull requests
There are many ways to contribute to open source. The best way to get started is via the issues feature on GitHub:
Issues are a way to communicate with the community. They are a way to report errors, ask questions, ask for help, or ask for feedback.
You can open an issue by clicking the "New issue" button in the upper right corner of the GitHub page, or by clicking this link.
If you're looking for a way to get started contributing, you can start by solving an issue. You can find a list of issues by clicking the "Issues" button in the upper right corner of the GitHub page, or by clicking this link.
The best issues to pick from are those with the Good first issue label, especially if you're a new contributor.
There are a series of steps to make changes to the code.
- Create a fork
- Create a branch
- Make changes to the code
- Submit a pull request
Make a pull request when you have made a change to the code. Generally, you will have a fork of the codebase, and you will make changes to the fork. You will then make a pull request to the main branch.
In your pull request description, you should include the following:
- A short summary of the changes you have made
- A link to the issue or issue comment that you are solving
- Screenshots of the app, highlighting the changes you have made
- Preferably pass the tests you have written
For more instructions on creating pull requests, see Creating a pull request.
Once your pull request is merged, you will be able to see the changes in the main branch. It may take a few days for the changes to be released to the app/play stores.
NOTE If you made a bug, you should be prepared to fix it. Make a new issue and add a link to the bug you found, and please include a screenshot of the bug.