Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 2.04 KB
Raw

Welcome Contributors

We welcome contributions to enhance Devika's capabilities and improve its performance. To report bugs, create a GitHub issue.

Before contributing, read through the existing issues and pull requests to see if someone else is already working on something similar. That way you can avoid duplicating efforts.

To contribute, please follow these steps:

  1. Fork the Devika repository on GitHub.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and ensure that the code passes all tests.
  4. Submit a pull request describing your changes and their benefits.

Pull Request Guidelines

When submitting a pull request, please follow these guidelines:

  1. Title: please include following prefixes:

    • Feature: for new features
    • Fix: for bug fixes
    • Docs: for documentation changes
    • Refactor: for code refactoring
    • Improve: for performance improvements
    • Other: for other changes

    for example:

    • Feature: added new feature to the code
    • Fix: fixed the bug in the code

  2. Description: Provide a clear and detailed description of your changes in the pull request. Explain the problem you are solving, the approach you took, and any potential side effects or limitations of your changes.

  3. Documentation: Update the relevant documentation to reflect your changes. This includes the README file, code comments, and any other relevant documentation.

  4. Dependencies: If your changes require new dependencies, ensure that they are properly documented and added to the requirements.txt or package.json files.

  5. if the pull request does not meet the above guidelines, it may be closed without merging.

Note: Please ensure that you have the latest version of the code before creating a pull request. If you have an existing fork, just sync your fork with the latest version of the Devika repository.

Please adhere to the coding conventions, maintain clear documentation, and provide thorough testing for your contributions.