Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

60 lines (36 loc) · 3.09 KB

Contributing to this Repository

😄🎉🖖 Thank you for your contribution! 😄🎉🖖

The following is a set of guidelines for contributing to CSC-510-Group-25 on GitHub. These are guidelines, not rules. Feel comfortable to make changes to this document in a pull request.

Table Of Contents

Code of Conduct

How Can I Contribute?

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to one of the members of our group.

How Can I Contribute?

Create an Issue

By running the test files and checking functionality of classes, you can generate an issue which we can address

Reporting Bugs

This section guides you through submitting a bug report for CSC-510-Group-25. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🔎 🥇

Before Submitting A Bug Report

Check if the Bug you found has already been discussed by someone else in the community. If it isn't present and you are aware under which section the bug should be reported in, then you can go ahead and submit a bug report.

How Do I Submit A (Good) Bug Report?

Describe the issue with as much detail as possible, so that the maintainers would be able to reproduce this issue.

  • Be descriptive in the title
  • Describe the steps you took to reproduce this isssue
  • Describe the behaviour which was seen and what was expected instead
  • Include screenshots
  • Mention the name and version of the OS being used

Suggesting Enhancements

Describe the enhancement with as much detail as possible, so that the maintainers would be able to understand why your enhancement is required.

  • Describe the enhancement with as much detail as possible
  • Describe what problem your enhancement solves
  • Describe how your enhancement would help the community

Pull Requests

Please follow the following steps to have your contribution considered by the maintainers:

  1. Follow all our guidelines and be respectful to the community
  2. After you submit your pull request, verify that all status checks are passing
    What if the status checks are not passing?If a status check is not passing, and you believe that this is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue

🤙 🖖 🥳 ❤️ Thanks again! Have a great day ❤️ 🥳 🖖 🤙