Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

69 lines (42 loc) · 3.16 KB
Raw

Contributing to EVIRE AI Framework

Thank you for considering contributing to the EVIRE AI Framework! We welcome contributions from the community and appreciate your help in improving our project. Please take a moment to read through these guidelines before you start contributing.

How Can You Contribute?

Reporting Bugs

If you find a bug in the project, please create an issue on our GitHub repository. Include as much detail as possible to help us reproduce and fix the issue. Screenshots, error messages, and steps to reproduce the bug are very helpful.

Suggesting Enhancements

We welcome suggestions for new features or improvements. Please create an issue on our GitHub repository to discuss your ideas. Be sure to explain the reasoning behind your suggestion and how it would benefit the project.

Submitting Pull Requests

If you want to contribute code to the project, follow these steps:

  1. Fork the repository: Click the "Fork" button at the top of the repository page to create a copy of the repository on your GitHub account.

  2. Clone your fork: Clone your forked repository to your local machine using the following command:

    git clone https://github.com/evireFW/ai-framework.git

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

    git checkout -b feature/your-feature-name

  4. Make your changes: Make the necessary changes in your local repository.

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

    git commit -m "Add feature: your-feature-name"

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

    git push origin feature/your-feature-name

  7. Create a pull request: Open a pull request from your forked repository to the main repository. Provide a detailed description of your changes and the purpose of the pull request.

Code Style

Please follow the existing code style in the project. Consistency helps maintain readability and quality. We use the following tools and guidelines:

  • Python: PEP 8
  • Solidity: Solidity Style Guide
  • JavaScript: StandardJS

Documentation

Good documentation is essential for any project. If you make changes to the code, please update the relevant documentation as well. This includes comments in the code, README files, and any other documentation files.

Rewards for Contributors

We occasionally offer rewards to contributors who make significant contributions to the project. These rewards can be in the form of digital tokens, recognition in the project, or other incentives. If you have made a meaningful contribution, you may be eligible for a reward. Please note that rewards are given at the discretion of the project maintainers.

Code of Conduct

We strive to create a welcoming and inclusive environment for everyone. Please read and adhere to our Code of Conduct to ensure a positive experience for all contributors.

Contact

If you have any questions or need assistance, feel free to reach out to us at [email protected].

Thank you for contributing to the AI Blockchain Framework!