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

Create CONTRIBUTING.md file #12

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Sejal1Verma
Copy link

@Sejal1Verma Sejal1Verma commented Oct 27, 2020

Few basic information for contributing to a repository.

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

Related issue

  • Issue Number : N/A <!-- Put the link of issue solved via PR in place of N/A>

Proposed changes

  • change 1
  • change 2
  • ........
  • ........
  • change n

Additional Information

  • any additional information or context

Checklists

  • Tests
  • Documentation

Screenshots

Original Updated
Original Screenshot Updated Screenshot

Few basic information for contributing to a repository.
@Sejal1Verma
Copy link
Author

@AasthaGitHub ma'am and @akrishna0 sir I request you to please review my work

Copy link
Contributor

@AasthaMehtaTech AasthaMehtaTech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @Sejal1Verma, greetings for your first contribution here.
Contributing guidelines would be more beginner friendly when we include the exact commands which one needs to follow. So, kindly make the following changes:

  • Describe exact steps (with commands - for different systems: Windows, Mac, Linux)
  • It'd be great if u could attach actual pictures of example how you made this PR.
  • In PR description remove the unnecessary details & point a reference to the prevailing documentation issue.
  • U might want to add the rules of maintaining the decorum/coding style while one wants to contribute.

@akrishna0
Copy link
Member

Please follow the template don't just make a pull request after making changes describe everything as asked in the PR template if possible

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants