Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

contributing docs updates #120

Merged
merged 4 commits into from
Jun 17, 2019
Merged

contributing docs updates #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
384193d
Update install instructions
Islast Jun 12, 2019
c6b8328
add style comments
Islast Jun 12, 2019
3278861
Merge remote-tracking branch 'upstream/master'
Islast Jun 12, 2019
18b8047
include ruslan's feedback
Islast Jun 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,4 +196,4 @@ And if you've found typos in this (or any other) page, you could consider submit
[link_hatrackhome]: https://labhr.github.io/
[link_hatrackidea]: http://hawthornlandings.org/2015/02/13/a-place-to-hang-your-hat/
[link_hatrackcontributions]: http://opensource.com/life/15/10/octohat-github-non-code-contribution-tracker
[link_fixingtyposissue]: https://github.com/WhitakerLab/scona//issues/4
[link_fixingtyposissue]: https://github.com/WhitakerLab/scona//issues/4
3 changes: 2 additions & 1 deletion DEVELOPMENT_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@ The [development guide](#development-guide) deals with the specifics of contribu

### Installing in editable mode

Use `pip install -e git+https://github.com/WhitakerLab/scona.git` to install scona in editable mode. This means that the python install of scona will be kept up to date with any changes you make, including switching branches in git.
Use `pip install -e git+https://github.com/WhitakerLab/scona.git#egg=scona` to install scona in editable mode. This means that the python install of scona will be kept up to date with any changes you make, including switching branches in git.

### Linting

scona uses the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/).
You can use [flake8](http://flake8.pycqa.org/en/latest/) to lint code.
We're quite a young project (at time of writing in January 2019) and so we aren't going to be super hardcore about your linting!
Linting should make your life easier, but if you're not sure how to get started, or if this is a barrier to you contributing to `scona` then don't worry about it or [get in touch](CONTRIBUTING.md#how-to-get-in-touch) and we'll be happy to help you.
Feel free also to correct unlinted code in scona when you come across it!:sparkles:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AMEN! 🙌


### Writing docstrings

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you don't want to bother reading the whole of this page, here are three place
* To install `scona` as a python package with pip

```
pip install git+https://github.com/WhitakerLab/scona.git
pip install git+https://github.com/WhitakerLab/scona.git#egg=scona
```

* Check out our [tutorial](tutorials/tutorial.ipynb) for examples of basic functionality.
Expand Down