Skip to content

Latest commit

 

History

History
124 lines (82 loc) · 4.08 KB

README.md

File metadata and controls

124 lines (82 loc) · 4.08 KB
Raw

Welcome to Kendralabs

Thank you for considering contributing to our projects! This document outlines the process for contributing to our repositories. Please follow these guidelines to ensure smooth collaboration and high-quality code.

Table of Contents

Getting Started

To get started with contributing, you'll need to set up your development environment. Ensure you have the following installed:

  • Git
  • [Any other project-specific requirements]

Cloning the Repository

First, clone the repository to your local machine:

git clone https://github.com/Kendralabs/REPO_NAME.git
cd REPO_NAME

Replace REPO_NAME with the name of the repository you are contributing to.

Setting Up the Project

Follow these steps to set up the project:

  1. Install the required dependencies:

    # Example for Python projects
pip install -r requirements.txt

# Example for Node.js projects
npm install

  2. Ensure all tests pass before making changes:

    # Example for Python projects
pytest

# Example for Node.js projects
npm test

  3. Create a .env file if necessary and configure your environment variables.

Contributing

Creating a Branch

  1. Create a new branch for your feature or bug fix:

    git checkout -b feature/my-new-feature

  2. Make your changes on the new branch.

Making a Pull Request

  1. Commit your changes with a descriptive commit message:

    git commit -m "Add feature X"

  2. Push your branch to GitHub:

    git push origin feature/my-new-feature

  3. Open a pull request from your branch to the main branch on GitHub.

  4. Fill out the pull request template, providing a clear description of your changes, why they're necessary, and any relevant issues.

  5. Wait for the maintainers to review your pull request. Make sure to address any feedback or requested changes promptly.

Code Quality

To ensure high-quality code, please adhere to the following guidelines:

  • Comments: Add comments to your code where necessary to explain complex logic or important details.
  • Naming Conventions: Use clear and descriptive names for folders, files, variables, functions, and classes. Avoid single-letter names or overly abbreviated names.
  • File and Folder Structure: Ensure that the project structure is logical and organized. Avoid having separate folders for each file unless absolutely necessary. Proper naming can help keep the project structure clean and navigable.
  • Path Correctness: Make sure all file paths are correct and relative to the project root. Avoid hardcoding paths that could break when the project structure changes.

Creating an Issue

If you find a bug or have a feature request, please create an issue using the following steps:

  1. Go to the repository's Issues tab.
  2. Click on New Issue.
  3. Fill out the issue template with the following information:
    • Title: A brief, descriptive title.
    • Description: Include the following details:
      • What you were doing when the issue occurred.
      • What you expected to happen.
      • What actually happened.
      • Any relevant screenshots or logs.

Code of Conduct

Please note that this project is governed by the Kendralabs Code of Conduct. By participating, you are expected to adhere to this code. Please report any unacceptable behavior to [email protected].

Giving the Project a Star

If you find our projects useful, please consider giving us a star on GitHub! This helps others discover our work and shows your support.

Thank you for your contributions!