From fde186aed49de5586179d40bed7b744bd0b36635 Mon Sep 17 00:00:00 2001 From: Tarek Allam Date: Mon, 13 May 2019 17:29:03 +0100 Subject: [PATCH] Minor comment on PEP8 E501 exception As well as fixing typo and upper-casing github --> Github --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e6940552..ed565b3e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -30,5 +30,5 @@ this can be achieve with `git pull --rebase upstream dev` If this reveals a myriad of conflicts, one can run: `git rebase --abort` and then one can submit a PR without checking the above box. -If you would like assistance with this, people contact on of the core developers +If you would like assistance with this, people contact one of the core developers of snmachine for help--> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a8a6e74d..4e1cf6e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,7 +55,7 @@ To submit a PR, please follow these steps: 2. Create a branch from `dev` on your fork with the convention of: `issue//one-or-two-word-token-description-of-issue` - If you are working on a `[FEATURE]`, please branch from `dev` with the convention of: `feauture//one-or-two-word-token-description-of-issue`, this is to allow for issues to be raised on specific features also, which would then have the convention of: - `feature//issue//short-description`(where issues on a particular feautre would be branched from the feature-branch in question) + `feature//issue//short-description`(where issues on a particular feature would be branched from the feature-branch in question) 3. Make changes, add code etc and open a PR @@ -64,7 +64,7 @@ Please ensure your branch is up-to-date with `dev` branch by rebasing your chang ## Code Style -Much of our code style follows the convention defined in [PEP8](https://pep8.org/). +Much of our code style follows the convention defined in [PEP8](https://pep8.org/), with the exception in some cases of [`E501`](https://lintlyci.github.io/Flake8Rules/rules/E501.html) In addition, codebase guidelines outlined in the [LSST Developer Guide](https://developer.lsst.io/python/style.html) and in the [LSST DESC Coding Guidelines](https://confluence.slac.stanford.edu/display/LSSTDESC/Interim+LSST+DESC+Paper+Tracking?preview=/217813295/244908471/LSST%20DESC%20Coding%20Guidelines%20v1.1.pdf) @@ -197,12 +197,12 @@ Furthermore, `snmachine` adopts the release formatting of ### Release Planning -The authors of this package have adopted [milestones on github](https://help.github.com/en/articles/about-milestones) as a vehile to +The authors of this package have adopted [milestones on Github](https://help.github.com/en/articles/about-milestones) as a vehile to scope and schedule upcoming releases. The main goal for a release is written in the milestone description. Then, any ideas, specific functionality, bugs, etcs submitted as [issues](https://help.github.com/en/articles/about-issues) pertinent to that goal are tagged for that milestone. Goals for milestone are -discussed openly via a github issue. +discussed openly via a Github issue. Past and upcoming releases can be seen on the [snmachine milestones page](https://github.com/LSSTDESC/snmachine/milestones).