You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dependabot[bot]
fc1f269a72
|
2 years ago | |
---|---|---|
.github | 8 years ago | |
doc | 7 years ago | |
release | 2 years ago | |
src | 5 years ago | |
.gitignore | 8 years ago | |
.travis.yml | 5 years ago | |
CONTRIBUTING.md | 5 years ago | |
LICENSE | 9 years ago | |
Makefile | 5 years ago | |
Makefile.global | 5 years ago | |
NEWS.md | 5 years ago | |
README.md | 5 years ago | |
RELEASE.md | 3 years ago | |
carto-package.json | 6 years ago | |
check-compatibility.sh | 5 years ago | |
check-up-to-date-with-master.sh | 8 years ago |
README.md
Crankshaft
CARTO Spatial Analysis extension for PostgreSQL.
Code organization
doc/
documentationsrc/
source code
pg/
contains the PostgreSQL extension source codepy/
Python module source code
release
released versions
Requirements
- PostgreSQL
- plpythonu (for PG12+, plpython3u) and postgis extensions
- python-scipy system package (see src/py/README.md)
Development Process
We use the branch develop
as the main integration branch for development. The master
is reserved to handle releases.
The process is as follows:
- Create a new topic branch from
develop
for any new feature or bugfix and commit their changes to it:
git fetch && git checkout -b my-cool-feature origin/develop
- Code, commit, push, repeat.
- Write some tests for your feature or bugfix.
- Update the NEWS.md doc.
- Create a pull request and mention relevant people for a peer review.
- Address the comments and improvements you get from the peer review.
In order for a pull request to be accepted, the following criteria should be met:
- The peer review should pass and no major issue should be left unaddressed.
- CI tests must pass (travis will take care of that).
Development Guidelines
For a detailed description of the development process please see the CONTRIBUTING.md guide.
Testing
The tests (both for SQL and Python) are executed by running, from the top directory:
sudo make install
make test
Release
The release process is described in the RELEASE.md guide and is the responsibility of the designated release manager.