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

Modified CONTRIBUTING.md file #35

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

Conversation

yoursmanjunad
Copy link

@yoursmanjunad yoursmanjunad commented Apr 25, 2023

Description

Description of what this PR does. What have you added or changed, and why? If it fixes a bug or resolves a feature request, be sure to link to that issue.

The goal of this pull request is to add updated information to the contributing guide for the benefit of contributors.

Description of Changes Made
In this PR, I've made the following changes:

  • Certain elements of the paper have been clarified to help contributors comprehend the principles more quickly and efficiently.

  • The document's basic idea has been modified to emphasize all of the specific requirements that contributors must follow in order to produce a successful pull request.

Reasons for Changes Mage

  • The improvements were made to improve the readability of the contributing guide and to ensure that contributors can draught and integrate pull requests correctly.

  • In their eagerness to contribute to the code, contributors frequently overlook essential guidelines. As a result, pull requests fail. To address this issue, we have implemented enhancements that emphasize the most important sections of the guide and assist contributors in prioritizing them. Our goal is to recognize and reward contributors for their achievements by making it easier for them to produce and merge pull requests.

Review Checks

Please check if the PR fulfills these requirements:

Put an x in the boxes that apply, Remove any lines that do not apply

  • 📝 The commit message is clear and descriptive
  • 🔐 The Security Considerations section in the PR description is complete - Please do not remove this
  • ✅ Tests for the changes have been added and run successfully including the new changes
  • 📄 Documentation has been added / updated (for bug fixes / features)

Dependencies

Add links to any pull requests or documentation related to this pull request.

N/A

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

  • Yes

Security Considerations

Are there any other security or data concerns to be aware of?

Please discuss the security implications/considerations relevant to the proposed change.
This may include...

  • security-relevant design decisions
  • concerns
  • important discussions
  • implementation-specific guidance and pitfalls
  • an outline of threats and risks and how they are being addressed.

N/A

Types of change

What kind of change does this Pull Request introduce?
Put an x in the boxes that apply

  • 🐛 Bugfix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🛠 Adding or updating configuration files, development scripts etc.
  • ♻️ Refactoring (no functional changes, no api changes)
  • 🧹 Chore (removing redunant files, fixing typos etc.)
  • 📄 Documentation Update
  • ❓ Other (if none of the other choices apply)

Testing

N/A

Other information

N/A

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.

1 participant