Coder Social home page Coder Social logo

foss42 / apidash Goto Github PK

View Code? Open in Web Editor NEW
1.2K 13.0 238.0 11.61 MB

API Dash is a beautiful open-source cross-platform API Client built using Flutter which can help you easily create & customize your API requests, visually inspect responses and generate API integration code. A lightweight alternative to postman/insomnia.

Home Page: https://apidash.dev

License: Apache License 2.0

Dart 100.00%
api api-client flutter client dart http-client http-requests developer-tools flutter-apps flutter-desktop

apidash's Introduction

API Dash ⚡️

Discord Server Invite

🚨 We are participating in GSoC 2024 🎉

GSoC
Link
Learn about GSoC Link
Organization page on GSoC Link
Project Ideas List Link
Application Guide Link
Discord Channel Link

Please support this initiative by giving this project a Star ⭐️

API Dash is a beautiful open-source cross-platform API Client that can help you easily create & customize your API requests, visually inspect responses (full list of supported mime-types) and generate API integration code (full list) on the go.

Image

Download

API Dash can be downloaded from the links below:

OS Distribution Installation Guide CPU/Architecture Download Link
macOS .dmg Link Apple Silicon & Intel Link
Windows .exe Link 64-bit Link
Linux .deb Link amd64 Link
arm64 Link
.rpm Link x86_64 Link
aarch64 Link
PKGBUILD (Arch Linux) Link x86_64 Link

List of Features

↗️ Create & Customize API Requests

  • Create different types of HTTP requests (GET, HEAD, POST, PATCH, PUT and DELETE).
  • Easily manipulate and play around with request inputs like headers, query parameters and body.
  • Full support to send text content with 🥳 Unicode/Emoji and preview any API response containing Unicode/Emoji.

💼 Organize Requests in Collections & Folders

  • Create collections and folders to organize your requests.
  • Press and Drag to Re-arrange requests.
  • Click and open popup menu to rename, duplicate and delete a request.

🔎 Visually Preview and Download Data & Multimedia API Responses

  • Inspect the API Response (HTTP status code, error message, headers, body, time taken).
  • View formatted code previews for responses of various content types like JSON, XML, YAML, HTML, SQL, etc.
  • API Dash helps explore, test & preview Multimedia API responses which is not supported by any other API client. You can directly test APIs that return images, PDF, audio & more. Check out the full list of supported mimetypes/formats here.
  • Save 💾 response body of any mimetype (image, text, etc.) directly in the Downloads folder of your system by clicking on the Download button.

👩🏻‍💻 Code Generation

  • We started out as the only open source API client which supported advanced Dart code generation to easily integrate APIs in Dart/Flutter projects or to directly run it on DartPad. With time we have added more code-gens and currently API Dash supports generation of well-tested integration codes for JavaScript, Python, Kotlin & various other languages. You can check out the full list of supported languages/libraries.

🌙 Full Dark Mode Support

  • Easily switch between light mode and dark mode.

💾 Data

  • Data is persisted locally on the disk. To save the current snapshot, just press the Save button in the collection pane.
  • Click and open the collection/folder popup menu to export it as HAR. This can be version controlled & can be directly imported in other API Clients like Postman, Paw, etc.
  • Export your entire data into a HAR (HTTP Archive) file. To access this option goto Settings > Export Data.

⚙️ Settings & Other Options

  • Customize various options using a dedicated Settings screen.
  • Window Configuration (Size & Position) is persisted and restored on app start. (Only macOS & Windows)

Code Generators

API Dash currently supports API integration code generation for the following languages/libraries.

Language Library Comment/Issues
cURL
HAR
C libcurl
C# RestSharp
Dart http
Dart dio
Go net/http
JavaScript axios
JavaScript fetch
JavaScript (node.js) axios
JavaScript (node.js) fetch
Python requests
Python http.client
Kotlin okhttp3
Ruby faraday
Ruby net/http
Rust reqwest
Rust ureq
Rust Actix Client
Java asynchttpclient
Java HttpClient
Java okhttp3
Java Unirest
Julia HTTP
PHP curl
PHP guzzle #143
PHP HTTPlug

We welcome contributions to support other programming languages/libraries/frameworks. Please check out more details here.

MIME Types supported by API Dash Response Previewer

API Dash is a next-gen API client that supports exploring, testing & previewing various data & multimedia API responses which is limited/not supported by other API clients. You can directly test APIs that return images, PDF, audio & more.

Here is the complete list of mimetypes that can be directly previewed in API Dash:

File Type Mimetype Extension Comment
PDF application/pdf .pdf
Video video/mp4 .mp4
Video video/webm .webm
Video video/x-ms-wmv .wmv
Video video/x-ms-asf .wmv
Video video/avi .avi
Video video/msvideo .avi
Video video/x-msvideo .avi
Video video/quicktime .mov
Video video/x-quicktime .mov
Video video/x-matroska .mkv
Image image/apng .apng Animated
Image image/avif .avif
Image image/bmp .bmp
Image image/gif .gif Animated
Image image/jpeg .jpeg or .jpg
Image image/jp2 .jp2
Image image/jpx .jpf or .jpx
Image image/pict .pct
Image image/portable-anymap .pnm
Image image/png .png
Image image/sgi .sgi
Image image/svg+xml .svg
Image image/tiff .tiff
Image image/targa .tga
Image image/vnd.wap.wbmp .wbmp
Image image/webp .webp
Image image/xwindowdump .xwd
Image image/x-icon .ico
Image image/x-portable-anymap .pnm
Image image/x-portable-bitmap .pbm
Image image/x-portable-graymap .pgm
Image image/x-portable-pixmap .ppm
Image image/x-tga .tga
Image image/x-xwindowdump .xwd
Audio audio/flac .flac
Audio audio/mpeg .mp3
Audio audio/mp4 .m4a or .mp4a
Audio audio/x-m4a .m4a
Audio audio/wav .wav
Audio audio/wave .wav
CSV text/csv .csv Can be improved

We welcome PRs to add support for previewing other multimedia mimetypes. Please go ahead and raise an issue so that we can discuss the approach. We are adding support for other mimetypes with each release. But, if you are looking for any particular mimetype support, please go ahead and open an issue. We will prioritize it's addition.

Here is the complete list of mimetypes that are syntax highlighted in API Dash:

Mimetype Extension Comment
application/json .json Other mimetypes like application/geo+json, application/vcard+json that are based on json are also supported.
application/xml .xml Other mimetypes like application/xhtml+xml, application/vcard+xml that are based on xml are also supported.
text/xml .xml
application/yaml .yaml Others - application/x-yaml or application/x-yml
text/yaml .yaml Others - text/yml
application/sql .sql
text/css .css
text/html .html Only syntax highlighting, no web preview.
text/javascript .js
text/markdown .md

What's new in v0.3.0?

Visit CHANGELOG.md

Provide Feedback, Report Bugs & Request New Features

Just click on the Issue tab to raise a new issue in this repo.

Contribute to API Dash

You can contribute to API Dash in any or all of the following ways:

Need Any Help?

In case you need any help with API Dash or are encountering any issue while running the tool, please feel free to drop by our Discord server and we can have a chat in the #foss-apidash channel.

apidash's People

Contributors

acousticdeveloper avatar animator avatar apoorvdwi avatar ashitaprasad avatar ashutosh7i avatar brawlerxull avatar ch1nru5t avatar densermeerkat avatar dushant-bansal avatar kop3sh avatar laiiihz avatar levo-777 avatar madhupashish avatar mixel2004 avatar mmjsmohit avatar morpheus-30 avatar nikkivirtuoso avatar nobodydotcode avatar opxdelwin avatar pcoder23 avatar priyaranjan12345 avatar royshruti avatar sixtusagbo avatar tanish2002 avatar tanishgl avatar tilakraj-b avatar vidya-hub avatar wisetarman avatar yashas-hm avatar yousef-rabia avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

apidash's Issues

Feature request: Collections

Tell us about the task you want to perform and are unable to do so because the feature is not available
I am working on more projects and I would like to somehow add my endpoints into folders and collections for better overview.

Describe the solution/feature you'd like us to add
For this I am using Collection feature in Postman:
image

Adding codegen for Python using http.client .

Tell us about the task you want to perform and are unable to do so because the feature is not available
Generate API Request code in Python using the code generator feature.

Describe the solution/feature you'd like us to add
Add Python Code Generator using http.client library

Any other feedback you would like to provide regarding the site
The Add header/url param button is very small and is not kinda visible, I had problem finding it for the first time!

Improve code generation for request body of type JSON

This improvement suggestion was highlighted in #9

In an app, JSON request body is created based on user input/parameters stored as a Map. This Map is then converted to a string when the request is about to be sent. Our code generator should reflect the same.

View Code window is not responsive

Describe the bug/problem
While opening the ViewCode Sidebar, if we reduce the width of the whole window, Pixels are overflowed

Steps to Reproduce the bug/problem

Open API Dash
Click on View Code
Reduce the width of API Dash window

Expected behavior
It must be responsive

Device Info (The device where you encountered this issue):

  • OS: LINUX
  • Version: Ubuntu 22.04.2 LTS
    Screenshot from 2023-06-23 17-24-53

Linux support

Tell us about the task you want to perform and are unable to do so because the feature is not available

Please consider making linux binaries for this

Describe the solution/feature you'd like us to add

Linux support either via deb, appimage, flatpak, etc.

Any other feedback you would like to provide regarding the site

It would be nice to be able to use this on linux :-)

Autocomplete/Autosuggestions while entering headers.

Tell us about the task you want to perform and are unable to do so because the feature is not available

While typing headers there are no suggestions. Adding suggestions will improve the UX.

Describe the solution/feature you'd like us to add

Solution -
While typing inside headers textfield let's give users auto suggestion.

Existing -
image

Proposed -
image

Any other feedback you would like to provide regarding the site

N/A

Are you working on this issue/Would you link to work on this issue?

Yes

Could this be ported to VSCODE editor as an extension?

I just want to ask if this is possible for Flutter apps?

Tell us about the task you want to perform and are unable to do so because the feature is not available
I would love to use this if this was integrated into VSCODE as an extension

Add Interactivity to JSON Viewing

Tell us about the task you want to perform and are unable to do so because the feature is not available
Add interactivity so it is small and easily viewable to the users

Describe the solution/feature you'd like us to add
used jsonview package incase of json and if the response is within the range

Any other feedback you would like to provide regarding the site
No for now

Add support to view PDF responses

Use case

User should be able to directly view the PDF in the response pane when the response is of content type application/pdf. Currently, the app allows users to download the PDF response.

Missing PR template

Addition of Pull Request Template to improve clarity and to make it easier for new contributors.

Please assign this issue to me under GSSoC'23 @animator

Adding a Contributors button at the left side Navigation bar.

I want to add a contributors button at the left side of the navigation bar.

after clicking on that button it will redirect you to new page where it will show about the contributors details on that page of the application.

Please assign me this issue for gssoc'23. I would love to work on it.

add readme badges

Tell us about the task you want to perform and are unable to do so because the feature is not available
check repo status

Describe the solution/feature you'd like us to add
I want to add readme badges

badges

Add a dropdown for language(library) selection in code pane.

Tell us about the task you want to perform and are unable to do so because the feature is not available
Switching between languages(libraries) to dynamically generate code using the code generation feature.

Describe the solution/feature you'd like us to add
A dropdown in code pane to switch between languages(libraries). It should be set to Dart by default and should present with a list of all the supported languages(libraries). It should also support search functionality.

Any other feedback you would like to provide regarding the site
No

[feat]: add a github action workflow for greeting contributors

Is your feature request related to a problem? Please describe.

Currently, this project does not have any action to greet to contributors. Github action is the great tool to automate the manual stuff for your project.

Describe the solution you'd like.

I would like to add a action workflow. This feature would automatically greet the author when specific event happens like:

  • When an issue is opened.
  • When a pull request is opened and merged.
  • When an issue is closed.
  • When an issue is assigned to someone, it notifies the assignee and start working.

How would this feature be beneficial for the project

  • The communication and engagement with the contributors will be improved.
  • It automates the process of manually greeting the contributors.

Record

  • I agree to follow project's contribution guidelines
  • I am a GSSoC'23 contributor
  • I want work on this issue

Please assign me this issue under GSS0C'23
Thanks.

Mobile Android/ iOS Support

Tell us about the task you want to perform and are unable to do so because the feature is not available
I would like to add support for Mobile Platforms i.e. Android, iOS this would allow to test APIs on-the-go. It might seem excessive and unnecessary but this kind of agility that enables everyone to test stuff on-the-go, having the same familiar UX and set of features providing continuity, with the added benefit of having a shared open-source codebase powered by flutter is what could potentially set this app apart from other competition.

Describe the solution/feature you'd like us to add
My proposal is building a preliminary mobile version of the app with a simplified UI/UX that can empower users to test APIs and endpoints in the simplest way possible on-the-go. This could potentially be utilized in adding future features like integrating a cross-platform sync; providing continuity for signed-up users.

Approach
This is obviously a fairly big feature to be added, for that my approach would be to start

  1. Designing an interface with the bare minimum of functional features coupled with the same beautiful design, (no changes, just adapting for smaller screens)
  2. Iteratively develop/ adapt code for the new platforms (starting with Android because it's usually more accessible)
  3. Test and add more features while maintaining this simple design language.

Feature request: Support environment variables

Tell us about the task you want to perform and are unable to do so because the feature is not available
I have various environment APIs (local, production, test,..) for every my project.
I don't want to write same things for more endpoints and then change it during change testing environments.

Describe the solution/feature you'd like us to add
I am using global environment variables in Postman.

[FIX] Additions in Issue template

Description:

I noticed that the repository does not have an appropriate issue template.

Issue Template: I want to add some more points to your issue template like styling changes, documentation, etc

Please assign this issue to me under Gssoc'23 @animator

Enhance SVG previewer

Use case

Currently, the app shows svg as an xml code instead of an image unlike other image formats.
User should be able to directly view SVG in the response pane when the response is of content type image/svg+xml.

Need to update Flutter Project (api-dash) Dependencies

Describe the bug/problem

This Flutter project (api-dash) is outdated, it is crucial to keep the project dependencies and versions up to date to leverage the latest features, bug fixes, and improvements offered by the Flutter ecosystem and its associated packages.

To resolve this issue, the dependencies listed in the project's "pubspec.yaml" file need to be updated to their latest versions.

Dependencies for upgrade --

Screenshot 2023-05-21 235627

Steps to Reproduce the bug/problem

  1. Go to pubspec.yaml file and build.gradle file for check the version
  2. Click on terminal and type "flutter pub get" to know the updates.
  3. Scroll down to see the updates

Expected behavior

Version up to date

Add audio player support for playing audio responses

Use case

User should be able to directly play the audio in the response pane when the response is of content type audio/ogg, audio/aac, etc. Full list of mimetypes available here. Currently, the app allows users to download the audio response.

Add back to top button

Tell us about the task you want to perform and are unable to do so because the feature is not available
I need to manually scroll up to top in readme

Describe the solution/feature you'd like us to add
I want to add scroll to top button in readme

Any other feedback you would like to provide regarding the site
Your response here

Addition of auto-comment.yml file

We need to add an auto-comment.yml that will automatically welcome, greet and provide necessary information to the contributors when they create new issues, PR, and when these will get assigned or merged respectively. This will promote motivation and performance.

@foss42 Please assign me this issue under gssoc'23

Dark Mode Support

Tell us about the task you want to perform and are unable to do so because the feature is not available
Dark Mode UI. This is a must for dev/data-driven apps that users will look at for long periods of time.

Describe the solution/feature you'd like us to add
The app should automatically adapt to the default mode of the OS, and also maybe have an option for manually changing it.

Any other feedback you would like to provide regarding the site
The UI in the app looks great, dark mode would allow users to appretiate it even more.

Improving User Experience: Relocating the "+ Add Parameter" Button and Introducing Checkbox Functionality for Parameter Management

To optimise the user experience when working with parameters in application, I propose the following suggestions:

Relocating the "+ Add Parameter" Button: Currently positioned at the bottom of the page, the button requires users to go down to the screen, which can be inconvenient, especially for users with portrait screens. To address this issue, we recommend relocating the button to a more accessible position below the parameter fields. This adjustment allows users to add new parameters without going down to the screen again and again.

Automatic Row Addition: Additionally, we suggest introducing an automatic row addition feature to simplify parameter input. Instead of relying solely on the "+ Add Parameter" button, users can start typing in a single text field located above the parameter list. As they type, a new empty row will automatically be added below, facilitating the effortless addition of new parameters. This streamlines the process and eliminates the need for users to manually click the button for each new parameter.

Checkbox Functionality for Parameter Management: Furthermore, I recommend incorporating checkboxes before each parameter. This feature empowers users to easily enable or disable specific parameters when testing their API. By checking or unchecking the corresponding checkbox, users can conveniently include or exclude specific parameters. This functionality provides greater flexibility and customization options for API testing.

For visual reference, please refer to the attached photo.

Desktop - 1

By implementing these suggested enhancements, we significantly enhance the user experience by reducing navigation efforts, streamlining parameter management, and providing a more intuitive and flexible application.

Addition of dependabot.yml file

We need to add dependabot.yml file as it helps us to keep our dependencies up to date. Every day, it checks your dependency files for outdated requirements and opens individual PRs for any it finds.

@foss42 please assign me this issue under gssoc'23.

Unable to Rename Requests in CollectionPane

Tell us about the task you want to perform and are unable to do so because the feature is not available
Currently, in the application, I am unable to rename requests in the CollectionPane, which makes it difficult to read and identify the request names. This feature is crucial to improve the usability and organization of the requests.

Describe the solution/feature you'd like us to add
I would like to request the addition of a feature that allows users to rename requests in the CollectionPane. This will enhance the user experience and enable better organization and identification of requests.

Any other feedback you would like to provide regarding the site
Overall, the API-Client is a great application. Thank you for your hard work on this project.

Ability to import requests from Postman

Tell us about the task you want to perform and are unable to do so because the feature is not available
Currently, there is no option to import JSON Collection exported from Postman into API Dash. If this feature is added, it would make the process of switching from Postman very swift.

Describe the solution/feature you'd like us to add
It would be nice if there was an interface where user can add collection exported from Postman into API Dash.

Any other feedback you would like to provide regarding the site
No
image

Related Documentation:
Postman essentials: exploring the collection format
Travelogue of Postman Collection Format v2
Using collections

Adding codegen for Kotlin using OkHttp

Tell us about the task you want to perform and are unable to do so because the feature is not available
Generate HTTP API Request code in Kotlin using the code generator feature.

Describe the solution/feature you'd like us to add
Add Kotlin Code Generation using the OkHttp package.

Any other feedback you would like to provide regarding the site
No

Below is a roadmap on how I plan to approach this. Please drop in your suggestions.

Roadmap

  1. Deciding on Language Switching in the Code Pane - Decide on what should be the UI/UX to switch between languages and libraries.
    image

  2. Implementing Kotlin Code Generation - Exploring OkHttp Package and adding the support for code generation using the same.

  3. Testing and Validation - Write tests for enhanced code coverage.

  4. Documentation - Making it easier for future contributors to add more languages and libraries.

Also, I have made a POC for the same and I would love to work on this issue. I have attached a screenshot showcasing the same.

Screenshot

Create Issue forms in the repo

Tell us about the task you want to perform and are unable to do so because the feature is not available
Currently the contributor has to raise an issue from ground zero without any prebuilt forms, to gain a better understanding of the issue raised we can create custom issue forms which will be visually appealing as well as be hassle free for the contributor to express their concern in an ordered manner .

Describe the solution/feature you'd like us to add
I will be deleting all the existing .md files under the issuetemplates and add yaml code for the respective forms.

Currently 👇

Screenshot 2023-06-14 at 15-04-07 New Issue · foss42_api-dash

Coming 👇

Screenshot 2023-06-13 at 23-28-00 New Issue · priyankarpal_ProjectsHut

Any other feedback you would like to provide regarding the site
Your response here

Field to enter headers/params gets disabled

Describe the bug/problem
In the field to enter params and headers there is no check if the user tried to remove the last index. So if the remove button is pressed, the row size becomes 0 and if pushed again, it throws an error disabling the field.

Steps to Reproduce the bug/problem
Click the remove button twice and resize the application to force rebuild it and then the field gets disabled

Note:
This is the remove button I am referring to in this issue.
image

image

Issues Template Modify

Issue 1

  • Issue template files are in .md format which is not looking good
  • it doesn't have separate columns for content and drop down menu and checkboxes

Current View

Screenshot 2023-06-27 111124

Solution

  • I will write yml code for issues template
  • I will add drop down menu for operating systems, Device, Version, browser etc.
  • Sample
temp img

Issue 2

  • There are no checkboxes in issue template
  • When contributor (GSSOC'23) raise a new issue then many time they didn't mention GSSOC label
  • It is also tough for project admin to label the issues

Solution

  • I will add important checkboxes in issue template (sample below)
2023-06-20

Add Pull Request Template

Describe the bug/problem

  • Adding a PR template
  • Template path .github\pull_request_template.md

Steps to Reproduce the bug/problem

  • Go to .github file
  • See error

Expected behavior

Repo with pull request template

Screenshots

Screenshot 2023-05-29 233408
Screenshot 2023-05-29 233534

Adding Hover effect on Buttons and fixing and align the Nav bar

Hello
I have an extraordinary skills to make website more attractive . I will make your website user friendly I will add these features:
Add Hover effect on button
Fixing and align attractive Nav bar ,sign in and up
And apply best background effect.
Please assign these issue under GSSOC'23.

Thank You

Add code generators for different programming languages (python, javascript, kotlin, etc.)

Objective
Currently, API Dash generates code for Dart language (using http package).
We should add more code generators for different languages like javascript, python, kotlin, etc.
Also, supporting different libraries for the same language like dio for Dart.

Location in the project
lib/codegen/

How to contribute

Step 1 - Choose a language and/or library for which you want to add the code generator.
Step 2 - Create a new issue with title Adding codegen for <language> using <library>.
Step 3 - Send a PR with the changes. In the description mention the issue you raised in Step 2.

Add CODE_OF_CONDUCT.md file

Hi there!
I recommend adding a CODE_OF_CONDUCT.md file to your repository. This file would serve as a guide for potential contributors, providing them with a clear set of expectations, guidelines, and behavior standards for participating in your project. It plays an essential role in creating a welcoming and inclusive environment for everyone involved.

I would like to work on this issue. Please assign it to me under GSSoC'23.

Thank you!

Adding codegen for Python using Request.

Tell us about the task you want to perform and are unable to do so because the feature is not available
Generate API Request code in Python using the code generator feature.

Describe the solution/feature you'd like us to add
Add Python Code Generator using Request library

Any other feedback you would like to provide regarding the site
No

Feature Request: Designing a website for "API Dash"

Describe the solution/feature you'd like us to add
Hi @animator, I was having an idea of designing a website for "API Dash".

Here all the details of the project will be added with some demo screenshots, videos, features and some description.
Also there can be a "Contact page" and "FAQs section". This will be easier for the user to get to know about the project very easily.

Also it will attract more users because of the beautiful UI of the website and the app.

Please assign this task to me under GSSOC'23, as I want to work on this issue 🙏🙏

Add Auto Comment Feature to Improve Collaboration

Issue Description:
As an active contributor to your open-source project, I believe that implementing an auto-comment feature would greatly enhance collaboration and communication within the project. This feature would automatically generate comments in response to specific events, such as when an issue is opened, a pull request is created, an issue is assigned, or an issue is unassigned.

Feature Details:

  • When an issue is opened, the auto-comment should greet the author and provide a brief acknowledgement and request for additional context.
  • When a pull request is opened, the auto-comment should greet the author, express gratitude, and remind them to follow the project's contributing guidelines.
  • When an issue is closed, the auto-comment should thank the author for their contribution and encourage further engagement.
  • When an issue is assigned to someone, the auto-comment should notify the assignee and encourage them to start working on it.
  • When an issue is unassigned from someone, the auto-comment should notify the assignee about the change and suggest reassignment if they are offline.

Benefits:

  • Improved communication and engagement with contributors.
  • Provides clear instructions and acknowledgements for various events.
  • Enhances collaboration by setting expectations and providing reminders.
  • Reduces manual effort by automating comment generation.

Acceptance Criteria:

  • The auto-comment feature should be implemented using the "wow-actions/auto-comment" GitHub Action.
  • Comments should be appropriately customized for each event, mentioning relevant parties and providing the necessary information.
  • The auto-comment workflow should trigger on the following events: issues opened, pull requests opened, issues closed, issues assigned, and issues unassigned.
  • The feature should be added to the project's existing GitHub Actions workflow file.

Additional Context:
Feel free to ask any questions or seek clarification regarding the auto-comment feature. I'm excited about contributing to your project and believe this enhancement will greatly benefit its community.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.