From 2e008688590aabc054a0ce875e4ac5a041532764 Mon Sep 17 00:00:00 2001 From: Hritobroto Sanyal <60534062+hritobroto@users.noreply.github.com> Date: Thu, 19 Aug 2021 00:24:42 +0530 Subject: [PATCH 1/2] updated links --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 2613569..cd8b633 100644 --- a/readme.md +++ b/readme.md @@ -55,4 +55,4 @@ you would leave it in. [quaternion]: http://en.wikipedia.org/wiki/Quaternion [stackoverflow.com]: http://stackoverflow.com/search?q=mathfu [vector]: http://en.wikipedia.org/wiki/Euclidean_vector - [CONTRIBUTING]: http://github.com/google/mathfu/blob/master/CONTRIBUTING + [CONTRIBUTING]: https://github.com/google/mathfu/blob/master/CONTRIBUTING.md From 88f11e24153f85ed2c3553ab98b9b984d54eeaed Mon Sep 17 00:00:00 2001 From: Hritobroto Sanyal <60534062+hritobroto@users.noreply.github.com> Date: Thu, 19 Aug 2021 00:51:58 +0530 Subject: [PATCH 2/2] Modifiied Contribution file --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2841def..30ebf51 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ Contributing ============ - +- All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. - Want to contribute? Great! First, read this page (including the small print at the end). @@ -13,4 +13,36 @@ Before we can use your code, you must sign the - All submissions, including submissions by project members, require review. We use Github pull requests for this purpose. # The small print -- Contributions made by corporations are covered by a different agreement than the one above, the Software Grant and Corporate Contributor License Agreement. \ No newline at end of file +- Contributions made by corporations are covered by a different agreement than the one above, the Software Grant and Corporate Contributor License Agreement. + +# Forking +You will need your own fork to work on the code. Go to the [mathfu](https://github.com/google/mathfu) project page and hit the ***Fork*** button. You will want to clone your fork to your machine: +``` +git clone https://github.com//mathfu.git +cd +git remote add upstream https://github.com/google/mathfu.git +``` + +# Creating a Branch +You want your master branch to reflect only production-ready code, so create a feature branch for making your changes. For example: +``` +git branch +git checkout +``` +This changes your working directory to the branch. Keep any changes in this branch specific to one bug or feature so it is clear what the branch brings to mathfu. + +# Committing your code +Once you’ve made changes, you can see them by typing: +``` +git status +``` +If you have created a new file and it is not being tracked by git. Add it by typing: +``` +git add path/to/file-to-be-added +``` + +# Pushing your changes +When you want your changes to appear publicly on your GitHub page, push your forked feature branch’s commits: +``` +git push origin +```