Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #26

Closed
wants to merge 2 commits into from

Conversation

shivamk23
Copy link

@shivamk23 shivamk23 commented Oct 7, 2023

What does this PR do?

This PR addresses and fixes the issue #18 . In this content, I have enhanced the welcome message and contribution guide for Review App, infusing it with a magical theme, vivid imagery, and step-by-step instructions reminiscent of embarking on a fantastical journey through the realms of coding and collaboration.

Fixes #18

Requirement/Documentation

  • Requirement document is attached.
  • UI/UX design document is attached.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

To test this PR: to test this PR I review contribution.md file many times.

  • Set the following environment variables: [list of environment variables, if any].
  • Minimal test data: [provide necessary data].
  • Expected (happy path) input and output: [describe expected input and output].
  • Other important information: [any details to help test the PR].

Mandatory Tasks

  • Self-review has been performed on the code. A decent size PR without self-review might be rejected.

Checklist

  • My code follows the style guidelines of this project.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have checked if my PR needs changes to the documentation.
  • I have checked if my changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have checked if new and existing unit tests pass locally

@github-actions
Copy link

github-actions bot commented Oct 7, 2023

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

No release type found in pull request title "Update CONTRIBUTING.md". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

@shivamk23 shivamk23 closed this Oct 7, 2023
@shivamk23 shivamk23 deleted the contribution branch October 7, 2023 15:59
@shivamk23 shivamk23 restored the contribution branch October 9, 2023 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Reference to Backend Repository in CONTRIBUTING.md
1 participant