Contributing to the API
We welcome contributions to improve this API project! Whether it’s fixing bugs, adding new features, improving documentation, or optimizing code, your help is always appreciated.
How to Contribute
1. Fork the Repository
Start by forking the repository to your GitHub account. This allows you to freely make changes without affecting the main project.
-
Navigate to the FreeApiHub GitHub repository and click the Fork button in the top right corner.
-
Once the repository is forked, clone it to your local machine:
git clone https://github.com/rehan-adi/FreeApiHub
Set Up Your Development Environment
Follow the steps in the README to set up the project on your local machine. Make sure you have all the required dependencies installed and configured.
Create a New Branch
Before making any changes, create a new branch with a descriptive name for your feature or bugfix. This helps keep your changes organized.
git checkout -b my-new-feature
Make Changes
- Fix bugs
- Add new features
- Improve documentation
- Refactor code for better performance or readability
Test Your Changes
Make sure your changes are working as expected. If applicable, test your changes many time.
Commit Your Changes
Commit your changes with a clear and concise commit message. Follow the commit message convention for better collaboration.
git add .
git commit -m "feat(api): add support for new endpoint"
git push origin my-new-feature
Create a Pull Request (PR)
Once you’re done, open a pull request (PR) to the main repository.
Review and Merge
Once your pull request is submitted, the maintainers will review it. If everything looks good, your changes will be merged into the main codebase.
Thank you for contributing! Your efforts help make FreeApiHub a better project for everyone.