We welcome contributions to Physix.go! This document outlines how you can get involved in the project's development.
Code Structure and meaning of every file
Check CODE_STRUCTURE.md
file explaining everything about code structure and meaning of every line.
Getting Started
-
Fork the Repository:
-
Clone your Fork:
-
Make Changes: Make your changes to the codebase.
-
Commit your Changes: Once you're satisfied with your changes, use
git add
to stage your changes andgit commit
to create a commit with a descriptive message. -
Push your Changes: Push your commits to your forked repository on GitHub using
git push origin master
. -
Create a Pull Request: On GitHub, navigate to your forked repository and click on the "Pull requests" tab. Click on "New pull request" and select the branch containing your changes. This will initiate a pull request to merge your changes with the original Physix.go repository.
Testing your Changes
Test your code whether it is working as expected or not.
Pull Request Review
Once you submit your pull request, a project maintainer will review your code. They may provide feedback or request modifications before merging your changes.
Additional Notes
- Feel free to open an issue on the project's GitHub repository https://github.com/rudransh61/Physix.go to discuss potential improvements or bug reports before working on a pull request.
- We appreciate contributions of all sizes, from bug fixes to new features.
We are happy to have you contribute to Physix.go!