Coder Social home page Coder Social logo

vmn-backend's People

Contributors

atheeqahmedmj avatar breathecode6365 avatar codex-gitam avatar anshiiiii avatar nagasurya avatar

Stargazers

 avatar

vmn-backend's Issues

Needed Contribution, Issue and Pull Request Guidelines and Templates

Issue Description

Problem

The current issue templates in the repository are outdated and insufficient, causing confusion among contributors and hindering the smooth process of opening and resolving issues. The lack of detailed instructions and examples is impeding the quality of issue reports, making it difficult for contributors to provide necessary information.
Proposed Solution

We need to update the contribution guidelines and issue templates to establish a standardized approach for contributors. The guidelines should cover essential aspects such as PR format, code quality standards, commit message conventions, and general issue reporting guidelines.

Changes to be Documented

  1. Contribution Guidelines:

    • Clarify the process for submitting issues and pull requests.
    • Specify the expected format for pull requests.
    • Define code formatting and quality standards.
    • Outline commit message format and conventions.
  2. Issue Templates:

    • Provide detailed instructions for opening bug fixes, feature requests, and other types of issues.
    • Include examples of well-structured issue reports.
    • Address common questions and concerns in the templates.

Expected Benefits

  1. Standardization:

  • Ensure that all contributors follow the same set of guidelines.
  • Facilitate a uniform and streamlined contribution process.
  1. Clarity:

  • Reduce confusion by providing clear and comprehensive instructions.
  • Enhance the quality of issue reports and pull requests.
  1. Efficiency:

  • Expedite issue resolution by improving the information provided in issue reports.
  • Streamline the review and merging process for pull requests.

Action Items

  • Collaborate on defining and documenting contribution guidelines.
  • Revise and enhance the existing issue templates.
  • Include examples and illustrations to aid contributors in understanding the guidelines.
  • Review and approve the updated guidelines and templates.

[FEATURE] Needed COACH to able to create VENTURE and invite Users with Role MENTEES

[FEATURE] Create Venture and Invite Mentees

Problem Description

As a User with role as COACH , need the ability to create a VENTURE and invite users to join with the role of MENTEES. This functionality is essential for managing mentoring relationships within the system.

Requirements

  1. Venture Creation:

    • COACH users should have the capability to create a new VENTURE.
    • Each VENTURE should have associated details, such as a name, description, and relevant information.
  2. User Invitation Service:

    • Extend the existing Invitation Service to include a method (inviteUserToVenture) for inviting users to join a specific VENTURE.
    • The method should take parameters such as the user's email, the VENTURE ID, and any additional information required for the invitation.
    • The Invitation Service should handle the invitation process and user role assignment (e.g., assigning the role of MENTEE).
    • InvitationController is only and also responsible for even this service.
  3. Venture Controller:

    • Create a new controller (Venture Controller) to manage venture-related services.
    • This controller should include endpoints for VENTURE creation and other venture-related operations.

Additional Details

  • The invitation process should be secure and should validate the authenticity of the invited users.
  • The invitation can be created only by the user with role as COACH

Acceptance Criteria

  • COACH users can successfully create a new VENTURE.
  • COACH users can invite other users to join the VENTURE as MENTEE using the inviteUserToVenture method.
  • The inviteUserToVenture method accurately assigns the role of MENTEE to the invited users.
  • The Venture Controller endpoints should be authenticated and are accessible and perform the required operations.

Definition of Done

  • Code implementation is completed.
  • Unit tests are written and pass successfully.
  • Integration tests are conducted, and the functionality is validated.
  • Documentation is updated to reflect the new features.
  • Code is reviewed and merged into the main branch.

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.