From d362d78b2c41741ac8397e55e3d0991377cc87f3 Mon Sep 17 00:00:00 2001 From: unknown Date: Wed, 29 Jul 2015 13:50:32 +0300 Subject: [PATCH 1/3] jebou --- docs/links.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/links.md b/docs/links.md index b3b9613..06b175e 100644 --- a/docs/links.md +++ b/docs/links.md @@ -22,4 +22,6 @@ Integration - http://arxiv.org/pdf/1411.1341.pdf Hierarchial shape functions -- https://www.math.vt.edu/people/adjerids/research/papers/basis.pdf \ No newline at end of file +- https://www.math.vt.edu/people/adjerids/research/papers/basis.pdf + +- edited by Ari \ No newline at end of file From 6d1716cf758d2c75749a96da7433ae31c1fc7771 Mon Sep 17 00:00:00 2001 From: arilaakk Date: Wed, 29 Jul 2015 15:42:38 +0300 Subject: [PATCH 2/3] Added basic contributing steps --- CONTRIBUTING.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4d66797..97eb5f3 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -9,6 +9,21 @@ For now, read https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md +How to contribute +----------------- +Here are the basic steps for contributing to JuliaFEM: +1) Create an account or sign in to GitHub +2) Install Git to your computer +3) Fork Julia to your repository (https://github.com/JuliaLang/julia) +4) Build Julia (v0.4+) to your computer +5) Fork JuliaFEM to your repository +6) Use Pkg.add() or git clone to access JuliaFEM +7) Make your contribution to the project +8) Add all updated files to the staging area: git add . +9) Commit the files to your repository and add a description message: +git commit -m "your_message_here" +10) At your repository, create a pull request + Developing ---------- ```bash From f7d659a957c8eec4240960cf6f1868391d2ab700 Mon Sep 17 00:00:00 2001 From: arilaakk Date: Mon, 3 Aug 2015 15:14:37 +0300 Subject: [PATCH 3/3] Updated the contributing instructions, added styling --- CONTRIBUTING.rst | 36 +++++++++++++++++++++++++----------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 97eb5f3..06b45de 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -12,17 +12,31 @@ https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md How to contribute ----------------- Here are the basic steps for contributing to JuliaFEM: -1) Create an account or sign in to GitHub -2) Install Git to your computer -3) Fork Julia to your repository (https://github.com/JuliaLang/julia) -4) Build Julia (v0.4+) to your computer -5) Fork JuliaFEM to your repository -6) Use Pkg.add() or git clone to access JuliaFEM -7) Make your contribution to the project -8) Add all updated files to the staging area: git add . -9) Commit the files to your repository and add a description message: -git commit -m "your_message_here" -10) At your repository, create a pull request + +1) Create an account or sign in to `GitHub `_. + +2) Go to `Git home page `_ and download the Git installer. Run the installer to get Git on your computer. It is a version control system used by GitHub. To learn its basics, go through this `Git tutorial `_. + +3) Install Julia (v0.4+) to your computer. At `Julia readme +`_ you'll find complete instructions for installing it for your platform. + +4) Go to the `JuliaFEM GitHub page `_. At the top-right corner, press the ``Fork``-button to fork your own copy of JuliaFEM to your repository. + +5) Clone JuliaFEM from your repository to your computer. Navigate to the folder you want to clone it to, and type the following command (inserting your GitHub username to its place): +``git clone https://github.com/your_github_username/JuliaFEM.jl.git`` + +6) You can now navigate to JuliaFEM in the folder you chose at step 5. There you'll find the same contents as you see in your GitHub JuliaFEM repository. Now, locate the file you want to modify, open it with your desired text editor, make the changes and save the new version. If you type ``git status``, you'll see that the files you've created or modified are listed under ``untracked files``. + +7) Add the files you want to update to the staging area by typing ``git add ...``. If you type ``git status``, you'll see that the files added to the staging area are listed under ``Changes to be committed``. This process also supports wildcard symbols. If you want to add all the files to the staging area, just type ``git add .``. If you want to remove a file from the staging area, type ``git reset ``. + +8) To store the staged files, commit the files to your repository and add a description message by typing ``git commit -m "your_message_here"``. The message should describe the changes that were made. + +9) When you are happy with the commits and want to update them to your repository, type ``git push origin master``. + +10) Go to your GitHub JuliaFEM repository. You'll notice that the commit you have made and pushed is now visible above the JuliaFEM file branch. If you click the ``latest commit`` link, you can see the changes made to the file. Finally, click ``Pull request`` to create a pull request of the commits you've made, so that other contributors can review it. + +11) If other contributors ask you to make changes to your pull request, just repeat steps 6-9. Your commits will be updated to your original pull request. Do this until everyone is satisfied and your pull request can be merged to the master branch. + Developing ----------