Contributing.md

Contributing to the Decision Support Project

Please note that this project is released with a contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Creating New Issues

• Review the Project Board to verify that the issue does not already appear as a project task.
• Search the Issues to determine related issues (epics, dependencies, not yet triaged, ...).
• Create a new issue using the "New Issue" button on the Issues page.
  • Choose an appropriate issue template (e.g., "Bug report", "User Story").
  • Change the title of the issue.
  • Modify the body of the issue in accordance with the template.

Making Changes

Here is the basic GitHub workflow for this project:

• Identify an active issue from the "Ready" column in the Project Board
• Fork the repository.
• Create a feature branch in your fork.
• Follow the Agile Principles outlined for the project (i.e., working, incremental, behavior-driven, test-dreiven).
• Include supporting documentation as appropriate.
• Before initiating a pull request (PR):
  • Verify quality, including adherence to Conventions and Technogies.
  • Build, run, and test a distribution build.
• Submit a pull request (PR) from your branch.
• One or more reviewers will review the request and may make comments in the PR conversation.
  • Participate in the conversation associated with the PR, updating your branch as appropriate.
• After reviewer approval, someone with commit access will merge the PR.

Project Workflow

Please refer to the Project Board

Project Discussions

This project uses Discussions for project-related announcements, questions and answers, ideas, and engaging in all discussions not related to a specific project Issue or Pull Request.

Conventions and Technologies

• Development Conventions
• Programming Language - Java
• Unit Testing - JUnit5
• Code Conventions - Checkstyle
• Issue Tracking - GitHub
• Work In Progess - GitHub Project Board
• Version Control - Git
• Build Process - Apache Ant & Command Line
• Under Consideration
  • Code Weakness Identification - PMD
  • Test Coverage - JaCoCo
  • Code Complexity Analysis - JaCoCo
  • Continuous Integration - Travis CI
  • Code Coverage - OpenClover
  • Accessibility - AccessLint

Contributor Links

• Development Conventions
• Code of Conduct
• Project Board (Approved Issues & Work In Progress)