Merge 9ab7804 into d1f48f7

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+
+# Automatic source code formatting
+- repo: https://github.com/ambv/black
+  rev: stable
+  hooks:
+  - id: black
+    args: [--safe, --quiet]
+
+# Syntax check and some basic flake8
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.0.0
+  hooks:
+  - id: check-ast
+  - id: flake8
+    args: ['--max-line-length=88', '--select=W291,W292,W293,F401']

docs/contributing.rst

@@ -1 +1,106 @@
-.. include:: ../CONTRIBUTING.rst
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/DiamondLightSource/ispyb-api/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+The ISPyB-API could always use more documentation, whether as part of the
+official ISPyB-API docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/DiamondLightSource/ispyb-api/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up the ISPyB-API for local development.
+
+1. Fork the `ispyb-api` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/ispyb-api.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv ispyb-api
+    $ cd ispyb-api/
+    $ python setup.py develop
+
+4. We use pre-commit hooks to ensure code is consistently formatted and passes basic flake8 checks. You can set this up using:::
+
+    $ pip install pre-commit
+    $ pre-commit install
+
+5. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+6. When you're done making changes, check that your changes pass the tests::
+
+    $ pytest
+
+   To get pytest, just pip install it into your virtualenv.
+
+7. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+8. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in HISTORY.rst.
+3. The pull request should work for all supported Python versions. Tests are run automatically for all versions on
+   https://travis-ci.org/DiamondLightSource/ispyb-api/pull_requests

setup.py

@@ -31,5 +31,6 @@
         "Operating System :: OS Independent",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
+    entry_points={"libtbx.precommit": ["ispyb = ispyb"]},
     project_urls={"Documentation": "https://ispyb.readthedocs.io"},
 )