Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (66 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

89 lines (66 loc) · 3.96 KB
Raw

Contributing to AKI

Thank you for your interest in contributing to the AfroCom AI Initiative (AKI)! We welcome contributions from everyone, and we are grateful for your efforts to improve the project. This document provides guidelines and best practices to help you get started.

Table of Contents

Code of Conduct

Please read and adhere to our Code of Conduct to ensure a positive and inclusive environment for everyone involved in the project.

How to Contribute

Types of Contributions

  1. Bug Reports: Report issues you encounter with as much detail as possible.
  2. Feature Requests: Suggest new features or improvements.
  3. Documentation: Improve existing documentation or add new documentation.
  4. Code Contributions: Fix bugs, implement new features, or improve code quality.
  5. Testing: Write tests to improve coverage and ensure robustness.

Getting Started

  1. Fork the Repository: Click the "Fork" button at the top right corner of the repository page to create a copy of the repository in your GitHub account.
  2. Clone the Repository: Clone your forked repository to your local machine: 
    git clone https://github.com/your-ubujima/AKI.git
cd AfroCom-AI-Initiative
  3. Create a Branch: Create a new branch for your work: 
    git checkout -b feature-name
  4. Set Up the Development Environment: Follow the instructions in the README.md to set up the development environment and install dependencies.

Reporting Issues

When reporting an issue, please include:

A clear and descriptive title. A detailed description of the problem, including steps to reproduce it. Any relevant screenshots or logs. Information about your environment (OS, Python version, etc.). To report an issue, go to the Issues page and click "New issue".

Submitting Pull Requests

  1. Commit Your Changes: Ensure your changes are well-documented and follow the project's style guidelines. Write clear and concise commit messages. 
    git add .
git commit -m "Description of changes"
  2. Push Your Changes: Push your branch to your forked repository 
    git push origin feature-name
  3. Open a Pull Request: Navigate to the original repository and click "New pull request". Select your branch and describe your changes in detail. Ensure your pull request (PR) is linked to any relevant issues.

PR Guidelines

  • Ensure your code passes all existing tests and includes new tests for your changes.
  • Update documentation if applicable.
  • Address any review comments and make necessary changes.

Style Guide

Code Style

  • Follow PEP 8 for Python code style.
  • Use meaningful variable and function names.
  • Keep functions and methods concise and focused on a single task.
  • Write comments and docstrings to explain complex logic and provide context.

Documentation

  • Use Markdown for documentation files.
  • Ensure documentation is clear, concise, and up-to-date.
  • Include examples and use cases where applicable.

Community and Support

Join our community on Slack, Discord or Google Doc to ask questions, share ideas, and get support from other contributors and maintainers.

For general questions or discussions, please use the GitHub Discussions feature.

License

By contributing to the AfroCom AI Initiative, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to the AfroCom AI Initiative! Your efforts help us build a better platform for the global Afro-community.