diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bcdde4a..9cfb951 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Development process -Please read the Working Process/Quickstart Guide in README.md first. +Please read the Working Process/Quickstart Guide in [README.md](https://github.com/CartoDB/crankshaft/blob/master/README.md) first. For any modification of crankshaft, such as adding new features, refactoring or bug-fixing, topic branch must be created out of the `develop` diff --git a/README.md b/README.md index 3ecb1d0..68a64fb 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ CartoDB Spatial Analysis extension for PostgreSQL. ## Requirements * pip, virtualenv, PostgreSQL -* python-scipy system package (see src/py/README.md) +* python-scipy system package (see [src/py/README.md](https://github.com/CartoDB/crankshaft/blob/master/src/py/README.md)) # Working Process -- Quickstart Guide @@ -33,7 +33,7 @@ deployed in production. Developers shall create a new topic branch from `develop` for any new feature or bugfix and commit their changes to it and eventually merge back into the `develop` branch. When a new release is required a Pull Request -will be open againt the `develop` branch. +will be open against the `develop` branch. The `develop` pull requests will be handled by the release manage, who will merge into master where new releases are prepared and tagged. @@ -43,7 +43,7 @@ and developers must not commit or merge into it. ## Development Guidelines For a detailed description of the development process please see -the CONTRIBUTING.md guide. +the [CONTRIBUTING.md](https://github.com/CartoDB/crankshaft/blob/master/CONTRIBUTING.md) guide. Any modification to the source code (`src/pg/sql` for the SQL extension, `src/py/crankshaft` for the Python package) shall always be done @@ -52,7 +52,7 @@ in a topic branch created from the `develop` branch. Tests, documentation and peer code reviewing are required for all modifications. -The tests (both for SQL and Pyhton) are executed by running, +The tests (both for SQL and Python) are executed by running, from the top directory: ``` @@ -67,5 +67,5 @@ branch. ## Release The release and deployment process is described in the -RELEASE.md guide and it is the responsibility of the designated +[RELEASE.md](https://github.com/CartoDB/crankshaft/blob/master/RELEASE.md) guide and it is the responsibility of the designated release manager. diff --git a/src/py/README.md b/src/py/README.md index b9bf64d..29a3145 100644 --- a/src/py/README.md +++ b/src/py/README.md @@ -8,7 +8,7 @@ cd crankshaft nosetests test/ ``` -## Notes about python dependencies +## Notes about Python dependencies * This extension is targeted at production databases. Therefore certain restrictions must be assumed about the production environment vs other experimental environments. * We're using `pip` and `virtualenv` to generate a suitable isolated environment for python code that has all the dependencies * Every dependency should be: