summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
Commit message (Collapse)AuthorAgeFilesLines
* Changed py39 from py27 in toxljhuang2022-07-291-4/+3
| | | | | | Changed py39 from py27 in tox for contributing doc Change-Id: Ia079b7b7f5d96858c7dfe4b3d103c0efd86ae68b
* Doc: move from freenode to OFTCLingxian Kong2021-06-011-6/+3
| | | | Change-Id: Ie398a633af429bf726f3b1ee85c93a1834c601b7
* fix bug report urlyangyong2019-09-031-11/+11
| | | | | | | since we don't use launchpad to report bugs anymore,replace it with storyboard.openstack.org Change-Id: Ifa456c62c4fed197954cb7f7b2aaf0328a00d6a3
* Move to opendevZhongShengping2019-04-241-1/+1
| | | | | | | 1.Use opendev.org instead of git.openstack.org. 2.Use review.opendev.org instead of review.openstack.org. Change-Id: I8e9da8fbb04bdec42a0b2f012f6a38b8ee413b27
* Extend contribution doc by IRC contact detailsMarcin Piwowarczyk2018-11-071-0/+10
| | | | | | Add details how to contact with trove members over IRC channel. Change-Id: I00ee60812c6a46f26c7eba24711941d9b5362c96
* Update URLs in documents according to document migrationmelissaml2017-11-031-6/+6
| | | | Change-Id: I4ef8a26df071746b6855a6a278840abdd77f2607
* Merge "Typo fix: encouter => encounter, lastest => latest"Jenkins2017-02-071-1/+1
|\
| * Typo fix: encouter => encounter, lastest => latestAnh Tran2017-01-261-1/+1
| | | | | | | | Change-Id: Ie78dc6427213ce4ead696a5649bc32bceac68c3a
* | Prepare for using standard python testsAndreas Jaeger2017-02-021-0/+4
|/ | | | | | | | | | | | | | | | | Add simple script to setup mysql and postgresql databases, this script can be run by users during testing and will be run by CI systems for specific setup before running unit tests. This allows to change in project-config the python-db jobs to python-jobs since python-jobs will call this script initially. Update CONTRIBUTING for this. See also http://lists.openstack.org/pipermail/openstack-dev/2016-November/107784.html Change-Id: I3463e75057d0d4544f6a0212da888759ab5e171b Needed-By: I92e6e6502c2c516babf2bf66f3514875f77c460e
* add section on code review priorityAmrith Kumar2016-11-011-1/+30
| | | | | | This section summarizes some discussions at the Barcelona summit. Change-Id: Ic6d81f9ee95ed24512b57669ecb1ad036ab87944
* Fix some typos in doc and commentsChangBo Guo(gcb)2016-10-041-1/+1
| | | | Change-Id: I7afe1d5851878fa392c46c7654e984e73de4246c
* update contributing.rst to reflect release notes and bugsAmrith Kumar2016-09-221-1/+30
| | | | | | | | | | | | | Hitherto we have tried to enforce the requirement that changes have Launchpad bugs. More openstack projects have moved away from this requirement and it may be time for Trove to do the same. We use reno for release notes and therefore if a release note is not specified in the commit, it will not make it to the official release notes page. We should therefore require release notes for all user visible changes. Change-Id: If72fc47c1d699b20a85574f5945ecff35cc0d008
* improve pylint; generate errors and config in sorted orderAmrith Kumar2016-09-191-3/+59
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since the config is not in a deterministic order makes it hard to compare two config's and see what changed. Personally, I'm not positive I understand this use-case; i.e. you have an existing config file, you save it, and then rebuild and then diff the two files. I'd have thought you'd just run check and the output of the tool was the diff. I however do see the value in sorting the file so that when someone submits a change that includes a change to the config, reviewers can see more easily what the change is doing. Similarly, the output from pylint (errors) are generated one file at a time and os.walk makes no guarantee of deterministic order. So we should collect all errors (across all files) and then print an ordered list for human consumption. The intent is also to make pylint voting soon (in master). the changes to contributing.rst and tox.ini are to make that easier. The config file has also been sorted in place. This change was motivated by an email exchange with Peter so I am marking him as a co-conspirator. The line numbers were removed from the tools/trove-pylint.config file as these would change whenever the line numbers in the file changed (since they are currently not being used in the comparison; they can be re-added if deemed necessary at the cost of having every 'rebuild' run create a different file). The tools/trove-pylint.config was regenerated as well, since the remaining two errors seem to be innocuous: ERROR: trove/taskmanager/manager.py 392: E1101 no-member, Manager.upgrade: Instance of 'BuiltInstance' has no 'upgrade' member (new method introduced by instance upgrade; other BuiltInstance member errors are already ignored.) and ERROR: trove/guestagent/datastore/experimental/postgresql/service/ access.py 80: E1101 no-member, PgSqlAccess.list_access: Instance ofi 'PgSqlAccess' has no '_find_user' member (this is due to the fact that PostgreSQL is spread over multiple files and pylint should cease to complain once https://review.openstack.org/#/c/346082/ lands.) Change-Id: I910c738d3845b7749e57910f76523150ec5a5bff Closes-Bug: #1625158 Closes-Bug: #1625245 Co-Authored-By: Peter Stachowski <peter@tesora.com>
* Adds the api-ref migrated RST + YAML filesAmrith Kumar2016-08-171-50/+5
| | | | | | | | | | | | | | | With this email[0], you must migrate API reference docs into RST. The conf.py and the tox environment are also cribbed from nova. Still need to retain the install_command in tox.ini, otherwise the api-ref job fails. [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Co-Authored-By: Anne Gentle <agentle@cisco.com> Co-Authored-By: Amrith Kumar <amrith@tesora.com> Change-Id: I3315261aa18729fa7a6aa79d4a1d6c24de1e2c6b
* Update CONTRIBUTING.rstAmrith Kumar2016-07-311-2/+29
| | | | | | | | Updated CONTRIBUTING.rst to reflect discussions at mid-cycle regarding abandonment of changes that are languishing in the gerrit review system. Change-Id: Ie9d22b01d09c2cdb250abd0596c0216ec457df4d
* Document house rules for approving changesAmrith Kumar2016-06-221-0/+28
| | | | | | | Document house rules for approving changes and a relaxation that we will adopt for the newton release cycle. Change-Id: Icc9b62740bcf5a604c492b5e36a970c93b7e8fc9
* Update Trove's READMEDeepaJon2016-05-041-0/+51
| | | | | | | | | | Updated the README.rst, In which updated about trove, getting started, python client for trove and reference, Removed the Usage for integration testing Tests and moved into CONTRIBUTION.rst Taken reference from other component's README.rst file. Change-Id: Ic3ce38155ecb120fc6fde1098fabb60be5383a64 Closes-Bug: #1572224
* Update CONTRIBUTING.RST fileAbitha Palaniappan2015-02-041-3/+1
| | | | | | I'm updating to reflect the discussion at the mid-cycle. Change-Id: I31fca6d8006531f9d61480ea70aa69f8047a36dc
* Spelling errors fixedsarvesh-ranjan2015-01-221-1/+1
| | | | Change-Id: I7d2eec61cb4f02819dd42900146739acd9c65cc4
* Merge "Clean up github references from docs"Jenkins2014-12-081-2/+73
|\
| * Clean up github references from docsMonty Taylor2014-12-051-2/+73
| | | | | | | | | | | | | | | | OpenStack hosts things in places that are not github. Also, it seems that there is a big blob of unrelated readme in the README file. Closes-Bug: 1399839 Change-Id: I70cc6772b50591c4b3badd6c92567a7a6541bacf
* | Workflow documentation is now in infra-manualJeremy Stanley2014-12-051-3/+3
|/ | | | | | | Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Change-Id: Ic33174d053274ab980c14da03b8394bfaf5375d3
* Update contributing.rst to include guidelines on Code ReviewAmrith Kumar2014-10-141-0/+61
| | | | | | | | | | | | | | | | | | | | | | | An important part of contributing to the Trove project is to review changes proposed by others. To reflect the value of this activity, and provide some guidelines on how the Trove project would like reviews to be conducted, I have updated the contributing.rst file with a summary of some conversations at the mid-cycle meetup. The intent is that reviews of this proposed change will be a discussion not only of the summary that I have attempted to capture, but also of the change(s) being proposed. I've opted to provide only rough guidelines and not provide exhaustive examples of "good" and "bad" reviews (the format used by, for example, the commit message guidelines) because the intent is not to create rigid and cumbersome process but rather to provide guidelines that reflect the desired purpose of the review process. It is acceptable to -1 this change if you find typographical errors, or have suggestions on the formatting of the document ;) Change-Id: I09432c335282c17974cb62b6f77cd00ebcdda21f
* Add CONTRIBUTING.rstliuqing2014-07-031-0/+16
There is no CONTRIBUTING.rst file, the patch will add it. Change-Id: I279ef20612e695244456e36399d0d908642f85d8 Closes-Bug: #1337182