Skip to content

Latest commit

 

History

History
67 lines (53 loc) · 2.94 KB

README.md

File metadata and controls

67 lines (53 loc) · 2.94 KB
Raw

Bug Report System

A Bug Report System integrate with other plateform(currently Im using this project on my games)

Getting Started

Download dll, and import into your project

How to use Bug Report

Below is a simple code sample usecase

Trello API & TOKEN link: [https://trello.com/app-key]

  • YOUR_TRELLO_API_KEY is your trello api key
  • YOUR_TRELLO_API_TOKEN is your trello api token
  • YOUR_TRELLO_BOARD_NAME is your trello board ID, which you can find it at your board url which looks like this: https://trello.com/b/YOUR_TRELLO_BOARD_ID/YOUR_BOARD_NAME
  • YOUR_TRELLO_DEFAULT_LIST_NAME is your trello board list name
using BugReportSystem;

public class Program{
    public static async Task Main(string[] args)
    {
        //Create Bug report instance
        BugReport bugReport = new BugReport();

        //Every plateform may have different parameters
        //In this case, using trello, there are few parameters you must to filled in, and able to use the trello api
        bugReport.allItems[BugReport.SupportItemIndex.Trello].parameters["API_KEY"] = "YOUR_API_KEY";
        bugReport.allItems[BugReport.SupportItemIndex.Trello].parameters["API_TOKEN"] = "YOUR_API_TOKEN";
        bugReport.allItems[BugReport.SupportItemIndex.Trello].parameters["BOARD_NAME"] = "YOUR_BOARD_ID";
        bugReport.allItems[BugReport.SupportItemIndex.Trello].parameters["DEFAULT_LIST_NAME"] = "YOUR_CARD_LIST_DEFAULT_NAME";

        //The actual report context
        bugReport.title = "Obiwan Bug Report";
        bugReport.summary = "Hello There!";
        bugReport.sendTime = DateTime.Now;
        //attachment is optional
        //bugReport.attachment = File.ReadAllBytes("image.jpg");
    
        //If return true, that's mean all the operation are successful executed
        bool success = await bugReport.SendReport();
        
        Console.WriteLine(success);
    }
}

Trello List Trello Card

There you go!

Also you may reference BugReportSystemSample C# console project to how you apply and use the BugReportSystem

Currently Support Plateform

Support Platform Status
Trello ✅

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request