Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

60 lines (36 loc) · 2.02 KB
Raw

Contributing to worb

Thank you for considering contributing to the worb library! We welcome contributions from the community to help improve and enhance the library for everyone.

Ways to Contribute

  • Reporting Bugs: If you find a bug or unexpected behavior, please open an issue on the GitHub repository with as much detail as possible.

  • Enhancements: If you have ideas to improve the library, feel free to create an issue to discuss them.

  • Code Contributions: If you're interested in adding features or fixing issues, follow the steps below to contribute code.

Code Contributions

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

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/weaze-id/worb.git
cd worb

  3. Create a Branch: Create a new branch for your feature or fix.

    git checkout -b my-feature

  4. Make Changes: Write code and make your desired changes. Ensure your code follows our coding guidelines.

  5. Commit Changes: Commit your changes with a meaningful commit message.

    git commit -m "Add new feature"

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

    git push origin my-feature

  7. Create a Pull Request: Go to the GitHub repository page and click on "New Pull Request". Choose the appropriate base and compare branches. Describe your changes and submit the pull request.

Coding Guidelines

  • Follow the existing coding style in the project.
  • Write clear and concise commit messages.
  • Include tests for new features and bug fixes.

Code of Conduct

Please note that we have a Code of Conduct in place to ensure a respectful and inclusive community. By participating, you are expected to uphold this code.

License

By contributing to the worb library, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing and making worb even better!