PSI Probe

Contributions

Please follow GitHub Flow, with the following additions:

• Ensure an issue exists before you begin work. If not, file one.
  • Your change should provide obvious material benefit to the project's users and/or developers. If in doubt, an issue serves as place to discuss your suggestion before you begin work.
  • Issues power the release changelogs, so your change will be made known to users after it's done.
• One PR per issue. Include the issue number in your commit(s) and PR so that merging it will close the issue.
• One issue per PR. Keep changes minimal, and keep the scope narrow. A small change is easier to review.
  • Avoid making formatting changes alongside functionality changes. This is a recipe for conflicts.
  • Avoid bumping version numbers or correcting spelling errors along with your changes unless they're necessary.
  • Feel free to make these sorts of corrections in a separate PR, though!

Building from Source

1. Clone PSI Probe's git repository.

   Note: If you plan to contribute to PSI Probe, you should create your own fork on GitHub first and clone that. Otherwise, follow these steps to build the latest version of PSI Probe for yourself.

   Execute the following command:

   git clone https://github.com/psi-probe/psi-probe
   

   This will create directory called psi-probe. Subsequent steps will refer to this as "your PSI Probe base directory."

2. Download and install Maven 3.

   You may download it from the Apache Maven website.

3. Run Maven.

   Execute the following command from your PSI Probe base directory:

   mvn package
   

   This will create a deployable file at web/target/probe.war.

User Groups

• Announcements
• Discussions