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

Added Contribution Guidelines #63

Merged
merged 1 commit into from
Oct 4, 2024

Conversation

ag21o9
Copy link

@ag21o9 ag21o9 commented Oct 4, 2024

Add Contribution Guidelines and Link in README.md

fixes issue #57

Description

This PR introduces the following changes:

  1. Created a CONTRIBUTION.md file:

    • Added clear guidelines on how to contribute, including:
      • How to fork and clone the repository.
      • How to create a new branch for feature or bug fixes.
      • Steps for committing and pushing changes.
      • Submitting a pull request.
      • Coding standards, commit message guidelines, and issue reporting instructions.
    • Included details about reporting bugs, creating pull requests, and the project's code of conduct.
  2. Linked CONTRIBUTION.md in README.md:

    • Updated the README.md to add a link to the contribution guidelines under the "Contribution" section.

Motivation and Context

These changes aim to make it easier for new contributors to understand how to contribute to the project and ensure consistency in contributions. The contribution guidelines provide clear instructions and best practices, helping maintain a smooth collaboration process.

How Has This Been Tested?

  • Reviewed the markdown formatting to ensure proper display.
  • Checked that the README.md link correctly points to the CONTRIBUTION.md file.

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Code refactor
  • Other (Please specify):

Checklist:

  • My code follows the code style of this project.
  • I have thoroughly tested my changes.
  • I have updated the documentation if necessary.
  • I have linked relevant issues in the PR description (if applicable).

@Kota-Karthik
Copy link
Owner

@ag21o9
LGTM!

@Kota-Karthik Kota-Karthik merged commit 28f2e5b into Kota-Karthik:main Oct 4, 2024
2 checks 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.

3 participants