Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

89 lines (62 loc) · 3.11 KB
Raw

Contributing to DSPyGen

First of all, thank you for considering contributing to DSPyGen! We appreciate your time and effort in helping improve our project. By contributing, you can help enhance the functionality, fix bugs, and add new features to make DSPyGen even better.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub repository. Make sure to include:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Any relevant logs, screenshots, or code snippets.

Suggesting Enhancements

If you have ideas for new features or enhancements, feel free to suggest them by opening an issue on our GitHub repository. Please include:

  • A clear and descriptive title.
  • A detailed description of the enhancement.
  • Any additional context or information that might be helpful.

Code Contributions

We welcome code contributions! To contribute, please follow these steps:

  1. Fork the Repository:

  2. Clone the Repository:

    • Clone your forked repository to your local machine: 
      git clone https://github.com/your-username/dspygen.git
cd dspygen

  3. Create a Branch:

    • Create a new branch for your feature or bugfix: 
      git checkout -b feature/your-feature-name

  4. Make Changes:

    • Make your changes in the codebase. Ensure that your code follows the project's coding standards and passes all tests.

  5. Commit Changes:

    • Commit your changes with a descriptive commit message: 
      git add .
git commit -m "Add detailed description of your changes"

  6. Push Changes:

    • Push your changes to your forked repository: 
      git push origin feature/your-feature-name

  7. Open a Pull Request:

    • Go to the original DSPyGen repository and open a pull request. Provide a detailed description of your changes and reference any related issues.

Review Process

  • All pull requests will be reviewed by a maintainer. We may suggest changes or ask for additional information before merging.
  • Ensure your pull request passes all CI/CD checks and includes relevant tests.
  • Be responsive to feedback and make necessary changes promptly.

Coding Standards

  • Follow the existing code style and conventions.
  • Write clear, concise, and well-documented code.
  • Include tests for new features and bug fixes.
  • Update documentation as needed.

Community Guidelines

  • Be respectful and considerate in all communications.
  • Provide constructive feedback and be open to receiving it.
  • Collaborate and help others whenever possible.

Contact

If you have any questions or need further assistance, feel free to reach out by opening an issue or contacting the maintainers.

Thank you for contributing to DSPyGen! Together, we can create a powerful tool for AI development.

For more information, visit our GitHub repository.