Skip to content

Conversation

@marcelomamorim
Copy link
Collaborator

@marcelomamorim marcelomamorim commented Nov 27, 2024

Adding Contributing.md, Templates for Issues and Pull Requests

Description

This pull request includes the following changes:

  1. Contributing Guide:

    • Created a CONTRIBUTING.md file outlining the guidelines for contributing to the project.
    • Added instructions on how to fork the repository, clone it, create branches, make changes, and push updates.
    • Included best practices for submitting pull requests, including running cargo fmt and cargo test before submitting.
    • Provided clear instructions for verifying that branches are up-to-date with main and resolving conflicts.
  2. Issue Template:

    • Added an issue template for reporting bugs or suggesting improvements.
    • The template includes sections for describing the issue, steps to reproduce, expected and actual behavior, and additional context.
    • Added environment details such as the operating system and version of Rust and Cargo for better debugging.
  3. Pull Request Template:

    • Created a pull request template in .github/PULL_REQUEST_TEMPLATE.md to standardize and simplify the process of submitting pull requests.
    • The template includes:
      • A checklist to ensure contributors have formatted their code and passed all tests.
      • Instructions for verifying that the branch has no conflicts with main and how to resolve them.
      • A section asking contributors to provide a clear description of their changes and follow best practices.
      • Reminders to run cargo fmt and cargo test.

Checklist

  • I have run cargo fmt to format the code.
  • I have run cargo test and verified that all tests pass.
  • I have added tests for the changes, if applicable.
  • I have updated documentation, if applicable.

Verifying Conflicts with Main

For detailed instructions, see GitHub's guide on resolving merge conflicts.

Copy link
Collaborator

@helpmehelpus helpmehelpus left a comment

Choose a reason for hiding this comment

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

It would be nice to have info on how to keep the fork in sync with the main repo. I left some notes in this PR on how to rebase

@marcelomamorim
Copy link
Collaborator Author

It would be nice to have info on how to keep the fork in sync with the main repo. I left some notes in this PR on how to rebase

@helpmehelpus Thank you for the feedback! I've added a detailed section about keeping forks in sync in both contributing guides.

@marcelomamorim marcelomamorim merged commit 0eb224d into main Dec 7, 2024
1 check passed
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