Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

65 lines (38 loc) · 2.08 KB

Contributing to InkNest

Thank you for considering contributing to InkNest! We welcome contributions from the community and are excited to see what you will bring to the project.

How to Contribute

Reporting Bugs

If you find a bug, please report it by creating an issue in our GitHub Issues page. Please include as much detail as possible to help us understand and reproduce the issue.

Suggesting Features

We are always looking for ways to improve InkNest. If you have a feature request, please open an issue in our GitHub Issues page and describe the feature you would like to see.

Submitting Pull Requests

  1. Fork the repository: Click the "Fork" button at the top right corner of the repository page.

  2. Clone your fork:

    git clone https://github.com/your-username/InkNest.git
    cd InkNest
  3. Create a new branch:

    git checkout -b my-feature-branch
  4. Make your changes: Implement your changes in the new branch.

  5. Commit your changes:

    git add .
    git commit -m "Description of your changes"
  6. Push to your fork:

    git push origin my-feature-branch
  7. Create a pull request: Go to the original repository and click the "New Pull Request" button. Select your branch and submit the pull request.

Code Style

Please ensure your code adheres to the project's coding standards. This includes proper indentation, comments, and following naming conventions.

Testing

Before submitting your pull request, please ensure that your changes do not break any existing tests and that new tests are added for any new functionality.

Documentation

If your changes affect the documentation, please update the relevant documentation files accordingly.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for contributing to InkNest!