Skip to content

004: How to contribute

Jump to bottom Edit New page
KaiGai Kohei edited this page Feb 13, 2018 · 3 revisions

Summary

This note introduces how to contribute the open source PG-Strom project. For general questions, requests, troubles and etc, please post it onto the community mailing-list. If you have bug-report or features proposition, please open a new issue ticket with appropriate tag.

Description

Community mailing-list

We have a community mailing-list at: https://groups.google.com/a/heterodb.com/forum/#!forum/pgstrom It is a right place to post questions, requests, troubles and etc, related to PG-Strom project.

Please pay attention it is a public list for world wide. So, it is your own responsibility not to disclose confidential information.

The primary language of the mailing-list is English. On the other hands, we know major portion of PG-Strom users are Japanese because of its development history, so we admit to have a discussion on the list in Japanese language. In this case, please don't forget to attach (JP) prefix on the subject like, for non-Japanese speakers to skip messages.

Bug reports

If you got troubles like incorrect results, system crash / lockup, or something strange behavior, please open a new issue with bug tag at the https://github.com/heterodb/pg-strom/issues .

Please ensure the items below on bug reports.

  • Whether you can reproduce the same problem on the latest revision?
    • Hopefully, we recommend to test on the latest OS, CUDA, PostgreSQL and related software.
  • Whether you can reproduce the same problem if PG-Strom is disabled?
    • GUC option pg_strom.enabled can turn on/off PG-Strom.
  • Is there any known issues on the issue tracker of GitHub?
    • Please don't forget to search closed issues

The information below are helpful for bug-reports.

  • Output of EXPLAIN VERBOSE for the queries in trouble.
  • Data structure of the tables involved with \d+ <table name> on psql command.
  • Log messages (verbose messages are more helpful)
  • Status of GUC options you modified from the default configurations.
  • Hardware configuration - GPU model and host RAM size especially.

If you are not certain whether the strange behavior on your site is bug or not, please report it to the mailing-list prior to the open a new issue ticket. Developers may be able to suggest you next action - like a request for extra information.

New features

If you have any ideas of new features, please open a new issue with feature tag at the https://github.com/heterodb/pg-strom/issues, then have a discussion with other developers.

A preferable design proposal will contain the items below.

  • What is your problem to solve / improve?
  • How much serious is it on your workloads / user case?
  • Way to implement your idea?
  • Expected downside, if any.

Once we could make a consensus about its necessity, coordinator will attach accepted tag and the issue ticket is used to track rest of the development. Elsewhere, the issue ticket got rejected tag and closed.

Once a proposal got rejected, we may have different decision in the future. If comprehensive circumstance would be changed, you don't need to hesitate revised proposition again.

On the development stage, please attach patch file on the issue ticket. We don't use pull request.

Metadata

Add a custom footer
Add a custom sidebar
Clone this wiki locally