From 71312b6cfbcfc349b5bce6e619de6acdbf46754b Mon Sep 17 00:00:00 2001 From: Archishman Sengupta <71402528+ArchishmanSengupta@users.noreply.github.com> Date: Mon, 22 Mar 2021 21:43:29 +0530 Subject: [PATCH 1/3] issue #719 solved --- docs/development.rst | 115 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 113 insertions(+), 2 deletions(-) diff --git a/docs/development.rst b/docs/development.rst index e207b45af..7b9dae228 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -1,6 +1,91 @@ .. _development: +1. System requirement : +Any system with basic configuration. +Operating System : Any (Windows / Linux / Mac). + +2. Software requirement : +Updated browser +python + +3. Skill set : +Knowledge of git & github. +python + +============================ +Setting Up local Environement +============================ + +============================ +Forking the Repo +============================ +1.Firstly you have to make your own copy of project. For that you have to fork the repository. You can find the fork button on the top-right side of the browser window. + +2.Kindly wait till it gets forked. + +3.After that copy will look like /MSS forked from Open-MSS/MSS. + +============================ +Cloning the Repo +============================ + +1.Now you have your own copy of project. Here you have to start your work. + +2.Go to desired location on your computer where you want to set-up the project. + +3.Right click there and click on git bash. A terminal window will pop up + +4.Type the command git clone .git and hit enter. + +5.Wait for few seconds till the project gets copied + +============================ +Setting up remote : +============================ + +1.Now you have to set up remote repositories + +2.Type git remote -v in terminal to list remote connections to your repo. + +3. It will show something like this: + +origin https://github.com//MSS.git (fetch) + +origin https://github.com//MSS.git (push) + +4. Now type the command git remote add upstream https://github.com/Open-MSS/MSS.git this will set upstream as main directory + +5. Again type in command git remote -v to check if remote has been set up correctly + +6. It should show something like this : + +origin https://github.com//MSS.git (fetch) + +origin https://github.com//MSS.git (push) + +upstream https://github.com/Open-MSS/MSS.git (fetch) + +upstream https://github.com/Open-MSS/MSS.git (push) + + +============================ +How to Report Bugs: +============================ +Please open a new issue in the appropriate GitHub repository `here `_ with steps to reproduce the problem you're experiencing. + +Be sure to include as much information including screenshots, text output, and both your expected and actual results. + +============================ +How to Request Enhancements: +============================ +First, please refer to the applicable `GitHub repository `_ and search `the repository's GitHub issues `_ to make sure your idea has not been (or is not still) considered. + +Then, please `create a new issue `_ in the GitHub repository describing your enhancement. + +Be sure to include as much detail as possible including step-by-step descriptions, specific examples, screenshots or mockups, and reasoning for why the enhancement might be worthwhile. + +============================ Development ============================ @@ -40,8 +125,8 @@ mss repository needs a different folder, e.g. workspace/mss. Avoid to mix data a Some of used packages are in the conda-forge channel located, so we have to add this channel to the default:: - $ conda config --add channels conda-forge - $ conda config --add channels defaults +$ conda config --add channels conda-forge +$ conda config --add channels defaults Your content of the .condarc config file should have defaults on top:: @@ -250,3 +335,29 @@ Publish on Conda Forge * send a pull request * maintainer will merge if there is no error + +============================ +Pushing your changes: +============================ + +1. Now you have made the changes , tested them, and built them. so now its time to push them. + +2. Goto your terminal and type git status and hit enter, this will show your changes from the files +3. Then type in git add and hit enter, this will add all the files to staging area +4. Commit the changes by git commit -m "" and hit enter. +5. Now push your branch to your fork by git push origin and hit enter. + + +============================ +Creating a pull request: +============================ +By this time you can see a message on your github fork as your fork is ahead of Open-MSS:develop by of commits and also you can see a button called Compare and pull request. + +Click on Compare and pull request button. + +You will see a template. + +Fill out the template completely by describing your change, cause of change, issue getting fixed etc. + +After filling the template completely click on Pull request + From bf1b11325c694a8eeb8459f7cc287a421a5bc01d Mon Sep 17 00:00:00 2001 From: Archishman Sengupta <71402528+ArchishmanSengupta@users.noreply.github.com> Date: Wed, 16 Jun 2021 22:39:44 +0530 Subject: [PATCH 2/3] updated development.rst --- docs/development.rst | 64 ++++++++++++++++++++++++-------------------- 1 file changed, 35 insertions(+), 29 deletions(-) diff --git a/docs/development.rst b/docs/development.rst index 7b9dae228..f2c4052c4 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -1,17 +1,19 @@ .. _development: -1. System requirement : -Any system with basic configuration. -Operating System : Any (Windows / Linux / Mac). +1. System requirements -2. Software requirement : -Updated browser -python + | Any system with basic configuration. + | Operating System : Any (Windows / Linux / Mac). -3. Skill set : -Knowledge of git & github. -python +2. Software requirement + | Python + | `Additional Requirements `_ + + +3. Skill set + | Knowledge of git & github + | python ============================ Setting Up local Environement @@ -20,53 +22,57 @@ Setting Up local Environement ============================ Forking the Repo ============================ -1.Firstly you have to make your own copy of project. For that you have to fork the repository. You can find the fork button on the top-right side of the browser window. +1. Firstly you have to make your own copy of project. For that you have to fork the repository. You can find the fork button on the top-right side of the browser window. -2.Kindly wait till it gets forked. +2. Kindly wait till it gets forked. -3.After that copy will look like /MSS forked from Open-MSS/MSS. +3. After that copy will look like */MSS* forked from *Open-MSS/MSS*. ============================ Cloning the Repo ============================ -1.Now you have your own copy of project. Here you have to start your work. +1. Now you have your own copy of project. Here you have to start your work. + +2. Go to desired location on your computer where you want to set-up the project. + +3. Right click there and click on git bash. A terminal window will pop up -2.Go to desired location on your computer where you want to set-up the project. +4. Click The big green button which says "Code". Copy the URL. `Like this `_ -3.Right click there and click on git bash. A terminal window will pop up +5. Now Type the command ``git clone .git`` and hit enter. -4.Type the command git clone .git and hit enter. +6. Wait for few seconds till the project gets copied -5.Wait for few seconds till the project gets copied + or simply head over here for `cloning a repository `_ ============================ Setting up remote : ============================ -1.Now you have to set up remote repositories +1. Now you have to set up remote repositories -2.Type git remote -v in terminal to list remote connections to your repo. +2. Type ``git remote -v`` in terminal to list remote connections to your repo. 3. It will show something like this: -origin https://github.com//MSS.git (fetch) + ``origin https://github.com//MSS.git`` (fetch) -origin https://github.com//MSS.git (push) + ``origin https://github.com//MSS.git`` (push) -4. Now type the command git remote add upstream https://github.com/Open-MSS/MSS.git this will set upstream as main directory +4. Now type the command git remote add upstream ``https://github.com/Open-MSS/MSS.git`` this will set upstream as main directory 5. Again type in command git remote -v to check if remote has been set up correctly 6. It should show something like this : -origin https://github.com//MSS.git (fetch) + ``origin https://github.com//MSS.git`` (fetch) -origin https://github.com//MSS.git (push) + ``origin https://github.com//MSS.git`` (push) -upstream https://github.com/Open-MSS/MSS.git (fetch) + upstream ``https://github.com/Open-MSS/MSS.git`` (fetch) -upstream https://github.com/Open-MSS/MSS.git (push) + upstream ``https://github.com/Open-MSS/MSS.git`` (push) ============================ @@ -340,12 +346,12 @@ Publish on Conda Forge Pushing your changes: ============================ -1. Now you have made the changes , tested them, and built them. so now its time to push them. +1. Now you have made the changes , tested them, and built them. so now it's time to push them. 2. Goto your terminal and type git status and hit enter, this will show your changes from the files 3. Then type in git add and hit enter, this will add all the files to staging area -4. Commit the changes by git commit -m "" and hit enter. -5. Now push your branch to your fork by git push origin and hit enter. +4. Commit the changes by ``git commit -m ""`` and hit enter. +5. Now push your branch to your fork by ``git push origin `` and hit enter. ============================ From 70ff4e4384d485943868687f0259230309b0aa6c Mon Sep 17 00:00:00 2001 From: Archishman Sengupta <71402528+ArchishmanSengupta@users.noreply.github.com> Date: Thu, 17 Jun 2021 22:30:12 +0530 Subject: [PATCH 3/3] updated development.rst --- docs/development.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/development.rst b/docs/development.rst index df112c26d..b3e834d9e 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -353,8 +353,7 @@ Publish on Conda Forge Pushing your changes: ============================ -1. Now you have made the changes , tested them, and built them. so now it's time to push them. - +1. Now you have made the changes, tested them and built them. So now it's time to push them. 2. Goto your terminal and type git status and hit enter, this will show your changes from the files 3. Then type in git add and hit enter, this will add all the files to staging area 4. Commit the changes by ``git commit -m ""`` and hit enter.