Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 2.37 KB
Raw

Contributing to Webcrumbs

Thank you for your interest in contributing to Webcrumbs! Your contributions are welcome and this guide will help you understand how to contribute to this project. Following these guidelines helps to ensure a productive environment for all contributors.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

  1. Check Existing Issues: Make sure to check if the bug has already been reported by searching on GitHub under Issues.
  2. New Issue: If you can't find an existing issue, open a new one. Be sure to include a descriptive title and detailed information to help reproduce the issue.

Suggesting Enhancements

  1. Check Existing Issues: Make sure your suggestion hasn't already been suggested by searching under Issues with the label "enhancement".
  2. New Issue: If it hasn't, create a new issue and label it as "enhancement". Provide a clear and descriptive rationale for your suggestion.

Pull Requests

  1. Fork the Repository: Fork the Webcrumbs repository to your GitHub account.
  2. Clone the Fork: Clone your forked repository to your local machine. 
    git clone https://github.com/[Your-GitHub-Username]/Webcrumbs.git
  3. Create a Branch: Navigate to the repository directory and create a new branch for your feature or fix. 
    git checkout -b feature/YourFeatureName
  4. Make Changes: Make your changes and commit them. 
    git add .
git commit -m "Describe your changes here"
  5. Push to Fork: Push your changes to your forked repository. 
    git push origin feature/YourFeatureName
  6. Create Pull Request: Navigate to the "Pull Requests" tab in the original Webcrumbs repository and click "New Pull Request". Choose your fork and the branch you worked on as the source for the pull request.

Additional Resources

Thank you for contributing to Webcrumbs!