Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 2.3 KB
Raw

Contributing to Dejavu

We appreciate your interest in contributing to Dejavu! Whether you want to report a bug, propose new features, or submit code changes, your contributions are highly valued. Please take a moment to review this guide for contributing to the project.

Submitting Issues

If you encounter any issues, bugs, or have feature requests, please check the existing issues to see if they have already been reported. If not, feel free to open a new issue, providing as much detail as possible. Include steps to reproduce the problem or a clear description of the new feature you are proposing.

Development Setup

To contribute to Dejavu, follow these steps to set up your development environment:

  • Fork the repository on GitHub.
  • Clone your forked repository to your local machine.
  • Install the necessary dependencies as mentioned in the README.md file.
  • Build and run Dejavu locally following the instructions provided in the README.md file.

Making Changes

  • Create a new branch for your changes. It's recommended to use a descriptive name for your branch.
  • Make your changes, adhering to the project's coding style guide and best practices.
  • Write and run appropriate tests to verify your changes.
  • Ensure all tests pass and the code adheres to the established style guide.
  • Commit your changes with clear and concise commit messages.
  • Push your changes to your forked repository.
  • Submit a pull request to the main repository, clearly describing the changes and the problem it solves.

Code Style Guide

  • Follow the existing well-known code style and naming conventions.
  • Write clear, descriptive, and concise code and comments.
  • Use meaningful variable, function, and class names.
  • Ensure proper indentation and formatting of the code.

License

By contributing to Dejavu, you agree that your contributions will be licensed under the MIT License that covers the project.

Code of Conduct

We expect all contributors to adhere to the Code of Conduct. Please ensure a friendly and respectful environment for everyone involved in the project.

Feedback and Contact

For any further questions, feedback, or assistance, you can contact the project maintainers by opening an issue.

Thank you for your willingness to contribute to Dejavu! We appreciate your support and look forward to your contributions.