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

Documentation: Enhancement Of Contributing.md #949

Merged
merged 1 commit into from
Oct 25, 2024

Conversation

milansamuel609
Copy link
Contributor

Enhanced the structure and also added some new sections

Pull Request for DL-Simplified 💡

Issue Title : #944

  • Info about the related issue (Aim of the project) : To improve the structure and also to add some more new sections
  • Name: Milan P Samuel
  • GitHub ID: milansamuel609
  • Email ID: [email protected]
  • **Idenitfy yourself: GSSoC extend and Hacktoberfest
  • Participant`)**

Closes: #944

Describe the add-ons or changes you've made 📃

I have enhanced the document and also added some new sections

Done the following changes :-

  1. Enhanced the project structure
  2. Added star our repository section
  3. Added first pull request steps section
  4. Added additional method of contributing through GitHub desktop section
  5. Added good coding practices section
  6. Added the pull request rules section

Type of change ☑️

What sort of change have you made:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, local variables)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested? ⚙️

I have tested it by checking each line and also by checking it in the preview mode.

Checklist: ☑️

  • My code follows the guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly wherever it was hard to understand.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added things that prove my fix is effective or that my feature works.
  • Any dependent changes have been merged and published in downstream modules.

Enhanced the structure and also added some new sections
Copy link

Our team will soon review your PR. Thanks @milansamuel609 :)

@milansamuel609
Copy link
Contributor Author

I have done the enhancements and also added some new sections. If everything is fine please kindly merge the PR and also please add the gssoc extend and level label.

@abhisheks008 abhisheks008 changed the title Update CONTRIBUTING.md Documentation: Enhancement Of Contributing.md Oct 25, 2024
Copy link
Owner

@abhisheks008 abhisheks008 left a comment

Choose a reason for hiding this comment

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

Approved!
@milansamuel609

@abhisheks008 abhisheks008 merged commit 3c705ab into abhisheks008:main Oct 25, 2024
1 check passed
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.

Documentation: Enhancement Of Contributing.md
2 participants