You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
26
+
27
+
2. Kindly wait till it gets forked.
28
+
29
+
3. After that copy will look like *<your-user-name>/MSS* forked from *Open-MSS/MSS*.
30
+
31
+
============================
32
+
Cloning the Repo
33
+
============================
34
+
35
+
1. Now you have your own copy of project. Here you have to start your work.
36
+
37
+
2. Go to desired location on your computer where you want to set-up the project.
38
+
39
+
3. Right click there and click on git bash. A terminal window will pop up
40
+
41
+
4. Click The big green button which says "Code". Copy the URL. `Like this <https://user-images.githubusercontent.com/71402528/122255281-9a855d80-ceeb-11eb-9f85-fed38db30562.png>`_
42
+
43
+
5. Now Type the command ``git clone <your-fork-url>.git`` and hit enter.
44
+
45
+
6. Wait for few seconds till the project gets copied
46
+
47
+
or simply head over here for `cloning a repository <https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository>`_
48
+
49
+
============================
50
+
Setting up remote :
51
+
============================
52
+
53
+
1. Now you have to set up remote repositories
54
+
55
+
2. Type ``git remote -v`` in terminal to list remote connections to your repo.
Please open a new issue in the appropriate GitHub repository `here <https://github.com/Open-MSS/MSS/issues/new>`_ with steps to reproduce the problem you're experiencing.
82
+
83
+
Be sure to include as much information including screenshots, text output, and both your expected and actual results.
84
+
85
+
============================
86
+
How to Request Enhancements:
87
+
============================
88
+
First, please refer to the applicable `GitHub repository <https://github.com/Open-MSS/MSS>`_ and search `the repository's GitHub issues <https://github.com/Open-MSS/MSS/issues>`_ to make sure your idea has not been (or is not still) considered.
89
+
90
+
Then, please `create a new issue <https://github.com/Open-MSS/MSS/issues/new>`_ in the GitHub repository describing your enhancement.
91
+
92
+
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.
93
+
94
+
============================
4
95
Development
5
96
============================
6
97
@@ -40,6 +131,7 @@ MSS repository needs a different folder, e.g. workspace/mss. Avoid to mix data a
40
131
41
132
MSS is based on the software of the conda-forge channel located, so we have to add this channel to the default::
42
133
134
+
43
135
$ conda config --add channels conda-forge
44
136
45
137
Your content of the .condarc config file should have conda-forge on top::
@@ -53,7 +145,7 @@ Create an environment and install the whole mss package dependencies then remove
53
145
54
146
$ conda create -n mssdev mamba
55
147
$ conda activate mssdev
56
-
$ mamba install mss --only-deps
148
+
$ mamba install mss=4.0.1 --only-deps
57
149
58
150
You can also use conda to install mss, but mamba is a way faster.
59
151
Compare versions used in the meta.yaml between stable and develop branch and apply needed changes.
@@ -256,3 +348,28 @@ Publish on Conda Forge
256
348
* send a pull request
257
349
* maintainer will merge if there is no error
258
350
351
+
352
+
============================
353
+
Pushing your changes:
354
+
============================
355
+
356
+
1. Now you have made the changes, tested them and built them. So now it's time to push them.
357
+
2. Goto your terminal and type git status and hit enter, this will show your changes from the files
358
+
3. Then type in git add and hit enter, this will add all the files to staging area
359
+
4. Commit the changes by ``git commit -m "<message-describing-your-change>"`` and hit enter.
360
+
5. Now push your branch to your fork by ``git push origin <your-branch-name>`` and hit enter.
361
+
362
+
363
+
============================
364
+
Creating a pull request:
365
+
============================
366
+
By this time you can see a message on your github fork as your fork is ahead of Open-MSS:develop by <number> of commits and also you can see a button called Compare and pull request.
367
+
368
+
Click on Compare and pull request button.
369
+
370
+
You will see a template.
371
+
372
+
Fill out the template completely by describing your change, cause of change, issue getting fixed etc.
373
+
374
+
After filling the template completely click on Pull request
0 commit comments