Stephen Ficklin
779f3fb74a
Some additional fixes to improve documentation
|
%!s(int64=3) %!d(string=hai) anos | |
|---|---|---|
| .github | %!s(int64=4) %!d(string=hai) anos | |
| docs | %!s(int64=3) %!d(string=hai) anos | |
| legacy | %!s(int64=4) %!d(string=hai) anos | |
| tests | %!s(int64=4) %!d(string=hai) anos | |
| tripal | %!s(int64=3) %!d(string=hai) anos | |
| tripal_bulk_loader | %!s(int64=4) %!d(string=hai) anos | |
| tripal_chado | %!s(int64=3) %!d(string=hai) anos | |
| tripal_chado_views | %!s(int64=4) %!d(string=hai) anos | |
| tripal_daemon | %!s(int64=4) %!d(string=hai) anos | |
| tripal_ds | %!s(int64=3) %!d(string=hai) anos | |
| tripal_ws | %!s(int64=4) %!d(string=hai) anos | |
| .all-contributorsrc | %!s(int64=4) %!d(string=hai) anos | |
| .gitignore | %!s(int64=6) %!d(string=hai) anos | |
| CONTRIBUTING.md | %!s(int64=5) %!d(string=hai) anos | |
| LICENSE.txt | %!s(int64=7) %!d(string=hai) anos | |
| README.md | %!s(int64=4) %!d(string=hai) anos | |
| composer.json | %!s(int64=4) %!d(string=hai) anos | |
| composer.lock | %!s(int64=5) %!d(string=hai) anos | |
| phpunit.xml | %!s(int64=6) %!d(string=hai) anos |
README.md
Welcome to the home of Tripal Development! If you are thinking to yourself "What is Tripal?", head over to our website, Tripal.info.
Current Status
- Recommended Version:
- Development:
: Focus is on bug fixes
: Full upgrade to Drupal 8/9 (development in T4D8 Repository).
- Tripal
and
are no longer supported by the Project Management Committee, although we will accept community submitted fixes for Tripal 2.x.
# Resources
- For information on how to use Tripal through the Administrative Interface: Tripal Users Guide
- For help extending Tripal or understanding how it works: Tripal Developers Guide
- To check if another group already developed the functionality you need: Listing of Available Extension Modules
- Tripal is developed by a world-wide community! See the description of our Governance Structure
- If you are the head of a research group looking to fund Tripal Development: Guide to Funding Proposal Development
- For how to install Tripal, follow the instructions in the online Tripal User's Guide for Tripal v2 or Tripal v3.
- For how to upgrade from Tripal 2 to Tripal 3, follow the Upgrade Instructions in the Tripal v3 User's Guide.
Contribution
Looking to contribute? That's Amazing -Welcome!!! Here's a quick run-down to get you started:
- We welcome all contributions!
- This github issue queue is open to: bug reports, usability concerns, performance issues, site administration or development questions, data storage discussions, etc.
- We ask that questions/concerns/bugs with extension modules be addressed in their respective repositories (including those under the Tripal organization).
- For feature request, please open an issue with detailed use cases and description. We would love to help you design a generic solution for the community whether it belongs in Tripal Core or an Extension module! Please wait to submit a PR until the Project Management Committee (PMC) indicates it is generally applicable and should be included in Core.
- For potential bugs or concerns, please open an issue being as descriptive as possible. Screenshots and steps to reproduce will help us, help you! If you know how to fix the issue, feel free to submit a pull request (PR) linked to the issue!
- For documentation contributions, click the "Edit on Github" link at the top of the page you want to improve! Instructions for our flavour of ReadtheDocs can be found on ReadtheDocs.
- See our quickstart if you need help on how to submit a PR: ReadtheDocs, how to create a PR.
- Click on issues > New Issue for helpful issue templates.
- For Tripal 4 (Drupal 8/9), see the T4D8 repository.
For more detailed guidelines see our full Contribution Documentation!
Github Communication Tips
- Don’t be afraid to mention people (@username) who are knowledgeable on the topic or invested. We are academics and overcommitted, it’s too easy for issues to go unanswered: don’t give up on us!
- Likewise, don’t be shy about bumping an issue if no one responds after a few days. Balancing responsibilities is hard.
- Want to get more involved? Issues marked with “Good beginner issue” are a good place to start if you want to try your hand at submitting a PR.
- Everyone is encouraged/welcome to comment on the issue queue! Tell us if you
- are experiencing the same problem
- have tried a suggested fix
- know of a potential solution or work-around
- have an opinion, idea or feedback of any kind!
- Be kind when interacting with others on Github! (see Code of Conduct below for further guidelines). We want to foster a welcoming, inclusive community!
- Constructive criticism is welcome and encouraged but should be worded such that it is helpful :-) Direct criticism towards the idea or solution rather than the person and focus on alternatives or improvements.
Code of Conduct
Be nice! If that’s insufficient, Tripal community defers to https://www.contributor-covenant.org/
Required Dependencies
- Drupal:
- Drupal 7.x
- Drupal core modules: Search, Path and PHP modules.
- Drupal contributed modules:
- Views
- Entity API
- PostgreSQL 9.3 or higher (9.5 required for Chado 1.2 to 1.3 upgrade)
- PHP 5.5+
- UNIX/Linux
Development Testing
To run PHP unit tests on your local system, run composer install to install developer-specific requirements. Next, create a .env file in your /Tests/ directory that defines the DRUPAL_ROOT variable, for example
DRUPAL_ROOT=/var/www/html
Then run PHPUnit from your root Tripal directory.
PHPUnit tests will also be run in the Travis CI build.
Read our testing guidelines.
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!