Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (26 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

29 lines (26 loc) · 1.74 KB

CONTRIBUTING GUIDELINES

Thank you for your interest in contributing to this project! We welcome contributions from the community. Please follow these guidelines to ensure a smooth contribution process.

How to Contribute

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page to create your own copy of the project.
  2. Clone Your Fork: Clone your forked repository to your local machine using: 
    git clone git@github.com:CapelleGab/snippets.dev.git
  3. Create a Branch: Create a new branch for your feature or bug fix: 
    git checkout -b my-feature-branch
  4. Make Changes: Implement your changes in the codebase following the code style CODERULES.
  5. Commit Your Changes: Commit your changes with a clear and descriptive commit message: 
    git commit -m "Add feature X or fix bug Y"
  6. Push to Your Fork: Push your changes to your forked repository: 
    git push origin my-feature-branch
  7. Create a Pull Request: Go to the original repository and create a pull request (PR) from your branch. Provide a clear description of the changes you made and why they are necessary.
    • Make sure to link any relevant issues by using #issue_number in the PR description.
  8. Review Process: Your PR will be reviewed by the maintainers. They may request changes or provide feedback. Be responsive to comments and make necessary adjustments.
  9. Merge: Once your PR is approved, it will be merged into the main branch. You can also merge it yourself if you have the necessary permissions.
  10. Delete Your Branch: After the PR is merged, you can delete your branch both locally and on your forked repository to keep things tidy.