dmahajan980 / grunt-github-release

A Grunt plugin to automate the process of creating a GitHub release for your project.

Hey there 👋
I’m Divyanshu Mahajan, an Electronics and Economics undergrad at BITS Pilani. I am a Sortware Developer with a strong interest in JavaScript, React, React Native, and Flutter. I love building products that:

• Deliver an amazing user interface and friendly user experience.
• Scale well while being performant.
• Care about accessibility and inclusiveness.

---

                                                             

Present Day

• 🔭 Seeking Full-time Opportunities
• 💼 Working with Schmooze as a Front-end Engineer (React, React Native, Flutter).
• 📝 Writes articles on Medium.

Let's Connect

Feel free to reach out for any exciting projects, internship opportunities or anything else you'd want to chat about.

grunt-github-release's Issues

Add documentation for all configuration options.

The project has come to a point where it'll be useful to have documentation about the required/optional configuration options, their meaning, supported types, and the allowed values.

As a reference, we can use the Fluid Community's gamepad-navigator and fluid-express. The key points that we should cover are:

1. What the option is.
2. What is it meant for.
3. What input type does it support.
4. What are the allowed/available values.

To ensure that the code is more readable, we should also add JSDoc comments wherever necessary.

Write unit and integration tests.

As the project continues to grow, we need to add tests so that it becomes easier to add new features and determine breaking changes to the code base. For unit tests, we can use Jest or any other unit-testing framework. However, the challenge lies in integration testing, where we'd need to figure out the exact approach to test the workflow and then decide upon the choice of testing framework.

It'd be better first to figure out the requirements for integration testing and then decide upon a multi-purpose testing framework.