Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

74 lines (54 loc) · 2.69 KB

Contributing to NEAR AI Developer Cookbook

We welcome contributions to the NEAR AI Developer Cookbook! This document outlines the process for contributing to this project and helps to ensure a smooth collaboration experience.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/near-ai-cookbook.git
cd near-ai-cookbook
  3. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name

Adding New Examples

We encourage contributors to add new examples that showcase different use cases and integrations with NEAR AI. When adding a new example:

  1. Create a new directory under the examples/ folder with a descriptive name.
  2. Include a README.md file in your example directory explaining the purpose and setup of your example.
  3. Ensure your code is well-documented and follows best practices.
  4. Update the main README.md file to include your new example in the Examples section.

Making Changes

  1. Make your changes in your feature branch.
  2. Test your changes thoroughly.
  3. Commit your changes with a clear and descriptive commit message: 
    git commit -m "Add example: your example description"
  4. Push your changes to your fork on GitHub: 
    git push origin feature/your-feature-name

Submitting a Pull Request

  1. Go to the original repository on GitHub.
  2. Click the "New pull request" button.
  3. Select your fork and the branch containing your changes.
  4. Provide a clear title and description for your pull request, explaining the purpose and impact of your changes.
  5. Submit the pull request for review.

Code Style and Standards

  • Follow PEP 8 guidelines for Python code.
  • Use meaningful variable and function names.
  • Include comments where necessary to explain complex logic.
  • Ensure compatibility with Python 3.8+.

Documentation

  • Update relevant documentation when adding new features or making significant changes.
  • Ensure your example includes clear instructions on how to set up and run it.

Reporting Issues

If you find a bug or have a suggestion for improvement:

  1. Check if the issue already exists in the GitHub issue tracker.
  2. If not, create a new issue with a clear title and description.
  3. Include steps to reproduce the issue if applicable.

Community and Conduct

  • Be respectful and considerate in your interactions with other contributors.
  • Follow the project's code of conduct (if available).
  • Help create a positive and inclusive environment for all contributors.

Thank you for contributing to the NEAR AI Developer Cookbook! Your efforts help improve and expand the resources available to the NEAR AI community.