|
1 | 1 | # Contributing Guidelines |
2 | 2 |
|
3 | | -You'd like to help? Great! :tada: |
4 | | - |
5 | | -[Clone your own local copy](https://help.github.com/en/articles/cloning-a-repository) of this repositry run the following in your terminal: |
6 | | - |
7 | | -```shell |
8 | | -git clone [email protected]:MetOffice/PyPRECIS.git |
9 | | -``` |
10 | | - |
11 | | -Consider [creating a conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) from the PyPRECIS dependencies specified in the `environment.yml` file: |
12 | | -```shell |
13 | | -conda env create -f environment.yml |
14 | | -``` |
15 | | -Remember to activate your new environment: |
16 | | -```shell |
17 | | -conda activate pyprecis-environment |
18 | | -``` |
19 | | - |
20 | | -:exclamation: *Note: As of v1.0 we are unable to provison the model data necessary for reproducing the full PyPRECIS learning environment via github due to it's substanation size. Contact the PRECIS team for more information.* |
21 | | - |
22 | | -## Before you start... |
23 | | -Read through the current issues to see what you can help with. If you have your own ideas for improvements, please start a new issues so we can track and discuss your improvement. You must create a new branch for any changes you make. |
24 | | - |
25 | | -**Please take note of the following guidelines when contributing to the PyPRECIS repository.** |
26 | | - |
27 | | -* Please do **not** make changes to the `master` branch. The `master` branch is reserved for files and code that has been fully tested and reviewed. Only the core PyPRECIS developers can/should push to the `master` branch. |
| 3 | +Please take note of the following guidelines when contributing to the PyPRECIS repository: |
28 | 4 |
|
| 5 | +* Please do **not** make changes to the `master` branch. The `master` branch is reserved for files and code that has been fully tested and reviewed. If you think something is ready to be pushed to the `master` branch please check with Saeed or Hamish first. |
29 | 6 | * The `develop` branch contains the latest holistic version of the `PyPRECIS` repository. Please branch off `develop` to fix a particular issue or add a new feature. |
30 | 7 | * Please use the following tokens at the start of a new branch name to help sign-post and group branches: |
31 | | - |
32 | | -Name | Description |
33 | | ----- | ----------- |
34 | | -new | Branch adding new code/files that don't exist in the repo |
35 | | -fix | Branch modifying code/files that already exist in the repo. |
36 | | -junk | Throwaway branch created to experiment |
37 | | - |
38 | | -* Git can pattern match branches to to give you an overview of all (e.g. fix) branches: |
39 | | - ```shell |
| 8 | +``` |
| 9 | +new Branch adding new code/files that don't exist in the repo. |
| 10 | +fix Branch modifying code/files that already exist in the repo. |
| 11 | +junk Throwaway branch created to experiment |
| 12 | +``` |
| 13 | + Git can pattern match branches to to give you an overview of all (e.g. fix) branches: |
| 14 | + ``` |
40 | 15 | git branch --list "fix/*" |
41 | 16 | ``` |
42 | 17 | * Use a forward slash to separate the token from the branch name. For example: |
43 | 18 | ``` |
44 | | -new/Wks10 |
45 | | -fix/Wks2_units |
| 19 | +new/Worksheet5 |
| 20 | +fix/worksheet2aUnits |
46 | 21 | ``` |
47 | | -* When you think your branch is ready to be merged into `develop`, open a new pull request. |
48 | | - |
49 | | -## Signposting |
50 | | -* **Issues** are tracked and discussed under the Issues tab. Please use issues to disucss proposed changes or capture improvements needed to work towards the next milestone. Issues or improvements that contribute to the next milestone to be captured in thr Wiki tab. |
51 | | -* **Pull requests** show branches that are currently under review. New pull requests are created in reponse to branch fixes identified and recorded in the Issues tab. |
52 | | -* **Wiki** is used for summarising update aims for future versions of the notebooks, and to record speculative improvements that cannot be action in the current milestone. |
53 | | - |
54 | | - |
55 | 22 |
|
56 | 23 | Other more general points to note: |
57 | 24 |
|
58 | | -* **Avoid long descriptive names.** Long branch names can be very helpful when you are looking at a list of branches but it can get in the way when looking at decorated one-line logs as the branch names can eat up most of the single line and abbreviate the visible part of the log. |
| 25 | +* **Avoid long descriptive names.** Long branch names can be very helpful when you are looking at a list of branches. But it can get in the way when looking at decorated one-line logs as the branch names can eat up most of the single line and abbreviate the visible part of the log. |
59 | 26 | * **Do not use bare numbers.** Do not use use bare numbers (or hex numbers) as part of your branch naming scheme. |
60 | 27 |
|
61 | | -## CONTRIBUTING.ipynb |
62 | | -The `CONTRIBUTING.ipyn` file contains the worksheet style guide. Please consult this for information on formatting the new and ammended worksheets in a consistent style. |
63 | | - |
64 | | -**If in doubt, please contact the PRECIS team ( [email protected]) if you |
65 | | -have questions.** |
66 | | - |
67 | | -<h5 align="center"> |
68 | | -<img src="notebooks/img/MO_MASTER_black_mono_for_light_backg_RBG.png" width="200" alt="Met Office"> <br> |
69 | | -© British Crown Copyright 2018 - 2019, Met Office |
70 | | -</h5> |
| 28 | +**If in doubt, please contact Saeed Sadri ( [email protected]) or Hamish Steptoe ( [email protected]) if you |
| 29 | +have questions** |
0 commit comments