Skip to content

Latest commit

 

History

History
22 lines (22 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

22 lines (22 loc) · 1.85 KB

Contributing to Team Awesome UML

Welcome, and thank you for contributing to this project!

This document will outline the ways in which you may contribute beyond writing code.

Asking Questions and Providing Feedback

All questions and feedback can be directly sent to the team at [email protected]. If your feedback involves an issue with the project feel free to report an issue. Steps on how to do so are described below.

Reporting Issues

Has a reproducible issue been found in UML? Do you want to request a new feature? Ways to effectively do so are outlined below.

Look For Existing Issues

If you come across an issue do the following before making a new issue:

  1. Be sure to search through the open issues tab for existing reports on the issue or new feature.
  2. If you find an existing report leave a relevant comment and add a reaction. Use reactions to upvote or downvote an issue.

If you cannot find an existing report for your issue or new feature, create one using the below guidelines.

Writing Good Bug Reports and Feature Requests

File a single issue per problem and feature request. Do not file multiple bugs or feature requests in the same issue.

Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.

The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.

Templates for bug reports and feature requests can be found under the code tab in the .github directory under the ISSUE_TEMPLATE subdirectory.

Contributing code

If you are intrested in contributing code for new features or bug fixes, please see the pull request template in the .github directory.