Contributing to the "a-tasbih-app" project involves forking the repository, creating a branch from your fork, and making your changes. Follow these steps to ensure a smooth contribution process.
-
Navigate to the Repository:
- Open your web browser and go to the a-tasbih-app GitHub repository.
-
Fork the Repository:
- Click the Fork button located at the top-right corner of the page.
- GitHub will create a copy of the repository in your own GitHub account.
-
Copy the URL:
- Go to your forked repository on GitHub (e.g.,
https://github.com/your-username/a-tasbih-app
). - Click the Code button and copy the URL under HTTPS or SSH.
- Go to your forked repository on GitHub (e.g.,
-
Open Terminal (or Git Bash):
- On your local machine, open your terminal or Git Bash.
-
Clone Your Fork:
- Run the following command, replacing
your-username
with your GitHub username anda-tasbih-app
with the repository name:git clone https://github.com/iotb-tech/a-tasbih-app.git
- Navigate to the project directory:
cd a-tasbih-app
- Run the following command, replacing
-
Check Out a New Branch:
- Create and switch to a new branch based on the
main
branch. It’s a good practice to use a descriptive name for your branch:git checkout -b your-branch-name
- For example, if you’re fixing a bug, you might name your branch
fix-bug-issue
.
- Create and switch to a new branch based on the
-
Verify Your Branch:
- Ensure you are on the correct branch by running:
git branch
- Ensure you are on the correct branch by running:
-
Edit Files:
- Use your preferred code editor to make changes to the project files.
-
Test Your Changes:
- Make sure to test your changes to ensure everything works as expected.
-
Stage Your Changes:
- Add the files you’ve modified or added:
git add .
- You can also specify individual files if you prefer:
git add path/to/your/file
- Add the files you’ve modified or added:
-
Commit Your Changes:
- Commit your changes with a descriptive message:
git commit -m "Your descriptive commit message"
- Commit your changes with a descriptive message:
- Push to Your Fork:
- Push your branch to your forked repository:
git push origin your-branch-name
- Push your branch to your forked repository:
-
Open GitHub:
- Go to the original repository (e.g.,
https://github.com/your-username/a-tasbih-app
).
- Go to the original repository (e.g.,
-
Create a Pull Request:
- Click on the Pull Requests tab.
- Click the New Pull Request button.
- Select the branch you created from your fork as the source branch and the
main
branch of the original repository as the target branch. - Add a descriptive title and comment for your pull request explaining your changes.
- Click Create Pull Request.
-
Monitor Your Pull Request:
- Keep an eye on your pull request for any feedback or comments from the project maintainers.
-
Make Updates:
- If required, make additional changes based on feedback and push them to your branch. The pull request will automatically update.
-
Wait for Approval:
- Once your pull request is reviewed and approved, it will be merged into the
main
branch by the project maintainers.
- Once your pull request is reviewed and approved, it will be merged into the
-
Celebrate Your Contribution:
- Congratulations! You’ve successfully contributed to the "a-tasbih-app" project. 🎉
- Read Contribution Guidelines: Always check the project's
CONTRIBUTING.md
file or other documentation for specific contribution guidelines. - Keep Your Fork Updated: Regularly pull changes from the original repository to keep your fork up to date.
By following these steps, you’ll be able to contribute effectively to the "a-tasbih-app" project. Thank you for your contributions!