Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.92 KB

Contributing to Stateful UI

Thank you for considering a contribution to Stateful UI. We appreciate all contributions, no matter how small or large. This document provides guidelines to ensure a smooth collaboration process.

Code of Conduct

Please be reminded that as a participant in this project, it is imperative that you adhere to our Code of Conduct. Kindly take the time to thoroughly review and comply with its guidelines. Thank you.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: git clone git@github.com:dmitry-ivashenko/StatefulUI.git
  3. Set up the project dependencies.
  4. Create a new branch for your work: git checkout -b your-feature-branch-name

Making Changes

  1. Make your changes in the new branch.
  2. Ensure your code follows the project's coding standards.
  3. Write tests that cover your changes (if applicable).
  4. Commit your changes: git commit -m "Brief description of your changes"

Submitting a Pull Request

  1. Push your changes to your fork on GitHub: git push origin your-feature-branch-name
  2. Go to the Stateful UI repository on GitHub.
  3. Click "New Pull Request" and choose your branch.
  4. Provide a brief description of your changes.
  5. Wait for a project maintainer to review your request.

Feedback

If your pull request gets rejected, don't get discouraged! We appreciate every contribution. Review the feedback, make the necessary changes, and try again.

Bug Reports

If you find a bug, please create an issue in the project's issue tracker. Provide as much detail as possible to help us understand and reproduce the problem.

Additional Notes

  • If you're looking for a way to start, check out the "good first issue" label in the issue tracker.
  • For larger changes, it's always a good idea to discuss your plans in an issue first.

Thank you for helping improve Stateful UI!