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

docs: adding Documentation details #184

Closed
wants to merge 1 commit into from

Conversation

Salik147
Copy link

What does this PR do?

This PR will add an importing details in contribute,md regarding stage changes which is very important to know specifically for newbies.

Fixes # (issue)
docs: Documentation only changes

Requirement/Documentation

  • If there is a requirement document, please, share it here.
  • If there is ab UI/UX design document, please, share it here.

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?

  • Are there environment variables that should be set?
  • What are the minimal test data to have?
  • What is expected (happy path) to have (input and output)?
  • Any other important info that could help to test that PR

Mandatory Tasks

  • [* ] Make sure you have self-reviewed the code. A decent size PR without self-review might be rejected.

Checklist

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

@github-actions
Copy link

Thank you for following the naming conventions! 🙏

@hemantwasthere
Copy link
Collaborator

Please put issue no. in the description so that we can see what issue it solves, and if there is no issue opened then please create an issue first and then link it with the PR.

For now, I am closing the PR

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.

2 participants