Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 1.53 KB
Raw

Contributing to sturdyc

Thank you for your interest in contributing to our project! Here are some guidelines to help you get started.

How to Contribute

  1. Fork the Repository: Click on the "Fork" button at the top of this page to create a copy of the repository on your account.

  2. Clone the Repository: Use the following command to clone the repository to your local machine:

    git clone https://github.com/creativecreature/sturdyc.git

  3. Create a Branch: Create a new branch for your changes. Use a descriptive name for your branch (e.g., fix-bug-123 or add-new-feature):

    git checkout -b your-branch-name

  4. Make Changes: Make your changes to the codebase. Ensure your code follows the project's coding standards and adds adequate tests.

  5. Commit Your Changes: Commit your changes with a clear and concise commit message:

    git commit -m "Description of your changes"

  6. Push Your Changes: Push your changes to your forked repository:

    git push origin your-branch-name

  7. Create a Pull Request: Go to the original repository and create a pull request. Provide a clear description of the changes you have made and any relevant information.

Reporting Issues

If you find a bug or have a feature request, please create an issue on the Issues page. Provide as much detail as possible to help us address the issue effectively.

Thank you for contributing!