SimpleTooltip is a MediaWiki extension that provides basic tooltips, supporting inline text and info icons
For documentation see: https://www.mediawiki.org/wiki/Extension:SimpleTooltip
We use SemVer for versioning. See the tags in this repository for available versions.
We welcome contributions from the community to help make SimpleTooltip better! Whether you’re fixing bugs, adding new features, improving documentation, or anything else, your efforts are valuable.
We try to follow the Conventional Commits specification for issues and commit messages to create good and meaningful change logs.
|
Note
|
The repository contains
submodules. Make
sure to clone with > git clone --recursive <REPO> If not done when cloning, it can be done by > git submodule init > git submodule update |
Click to see detailed Contributing Guidelines
Step 1: Clone the Repository
Fork and clone our repo to your local machine:
git clone https://github.com/username/projectname.git --recursiveStep 2: Ensure test container is running
This repository supports "docker-compose-ci" based CI and testing for MediaWiki extensions.
The docker-compose-ci repository has already been integrated into the SimpleTooltip repository as a Git submodule. It uses "Make" as main entry point and command line interface.
Ensure, you have Make and Docker installed:
make --version
docker --versionRun lint, phpcs and tests:
make ciStep 3: Start coding
Make sure there is an issue that describes your changes. Create a new branch and start working on your changes. In issue-1234 replace 1234 with your issue number:
git checkout -b issue-1234Step 4: Test your changes
Ensure that your changes include adequate testing where applicable.
Run lint, phpcs and tests:
make ciStep 5: Commit your changes
Make sure your commits are well-documented. Try to follow the Conventional Commits specification to help us writing good and meaningful change logs.
git commit -m "Description of your changes"Step 6: Push! Push your branch and open a pull request.
git push origin feature/your-feature-nameUses the Tooltipster Library and Fugue Icons
This extension is part of semantic::core - Enterprise Class MediaWiki distribution.