Skip to content

Latest commit

 

History

History
124 lines (82 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

124 lines (82 loc) · 3.66 KB
Raw

Contributing to Zapher

Thank you for considering contributing to Zapher! We appreciate your support and are excited to work with you. This document outlines the steps and guidelines for contributing to the project.

How Can You Contribute?

There are several ways you can contribute to Zapher:

  • Reporting bugs
  • Suggesting features
  • Improving documentation
  • Writing code for new features or bug fixes

Reporting Bugs

If you encounter any bugs, please report them by following these steps:

  1. Search for existing issues to ensure the bug hasn't been reported already.
  2. Open a new issue if you can't find an existing one.
  3. Include detailed information about the bug:
    • Steps to reproduce
    • Expected behavior
    • Actual behavior
    • Screenshots or logs, if applicable

Suggesting Features

We welcome new feature suggestions! To suggest a feature:

  1. Search for existing feature requests to avoid duplicates.
  2. Open a new issue if you can't find an existing one.
  3. Provide a detailed description of the feature:
    • The problem it solves
    • How it would benefit users
    • Any implementation ideas you have

Improving Documentation

Good documentation is crucial for any project. You can help by:

  • Fixing typos or grammatical errors
  • Clarifying existing documentation
  • Writing new documentation for features or processes

Contributing Code

Getting Started

  1. Fork the repository by clicking the "Fork" button at the top right of the GitHub page.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/yourusername/zapher.git
cd zapher

  3. Add the upstream repository:

    git remote add upstream https://github.com/originalowner/zapher.git

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

    git checkout -b feature-branch

Making Changes

  1. Make your changes in the new branch.

  2. Commit your changes with a meaningful commit message:

    git add .
git commit -m "Description of your changes"

  3. Push your changes to your forked repository:

    git push origin feature-branch

Creating a Pull Request

  1. Go to your forked repository on GitHub.
  2. Click on the "Compare & pull request" button next to your branch.
  3. Provide a descriptive title and detailed description of your changes.
  4. Submit the pull request.

Code Style and Guidelines

  • Follow the coding style used in the existing codebase.
  • Write clear, concise, and meaningful commit messages.
  • Ensure your code passes all tests and lint checks.
  • Write tests for new features or bug fixes.

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.

Community

Join our community to ask questions, share ideas, and get support:

Learning Resources

If you're new to the technologies used in Zapher, here are some resources to get you started:

Thank You

Thank you for taking the time to contribute to Zapher. Your help is appreciated, and we look forward to working with you!

If you have any questions or need further assistance, feel free to open an issue or contact us via the community channels.

Happy coding!