Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 2.28 KB

CONTRIBUTE.md

File metadata and controls

71 lines (43 loc) · 2.28 KB
Raw

Contributing to AILibrary

Thank you for considering contributing to AILibrary! We welcome contributions from the community and are grateful for your support.

How to Contribute

Reporting Issues

If you encounter any bugs or have feature requests, please report them by creating an issue in the issue tracker. When reporting an issue, please include:

  • A clear and descriptive title.
  • A detailed description of the problem or suggestion.
  • Steps to reproduce the issue (if applicable).
  • Any relevant logs or screenshots.

Submitting Code Changes

We follow a standard Git workflow for submitting code changes. Here are the steps:

  1. Fork the Repository: Fork the repository to your own GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine.

    git clone https://github.com/dxns-hub/ai-library.git

  3. Create a Branch: Create a new branch for your changes.

    git checkout -b feature/your-feature-name

  4. Make Changes: Make your changes in the new branch.

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

    git add .
git commit -m "Add feature: your feature description"

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

    git push origin feature/your-feature-name

  7. Create a Pull Request: Create a pull request from your forked repository to the main repository. Please include a detailed description of your changes and reference any related issues.

Code Style

Please follow the coding standards used in the project. We use PEP 8 for Python code. Ensure your code is well-documented and includes comments where necessary.

Running Tests

Before submitting your changes, make sure to run the tests to ensure everything is working correctly. You can run the tests using:

pytest

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

#Getting Help

If you need help or have any questions, feel free to reach out by creating an issue in the issue tracker.

Thank you for your contributions!