Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (57 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

85 lines (57 loc) · 2.35 KB

Contributing to code-practice

Thank you for your interest in contributing to code-practice! Contributions from the community are welcome and appreciated.

This document outlines the process for contributing, whether you're reporting bugs, suggesting enhancements, improving documentation, or submitting code.

Table of Contents

Getting Started

  1. Fork the repository.

  2. Clone your fork to your local machine:

    git clone https://github.com/YOUR_USERNAME/code-practice.git

  3. Create a new branch for your feature or fix:

    git checkout -b your-branch-name

  4. Make your changes and commit them.

  5. Push to your fork and submit a pull request.

How to Contribute

You can contribute in many ways:

  • Fix bugs or typos
  • Improve documentation
  • Suggest new features
  • Submit new code
  • Write tests
  • Review pull requests

Please check the issues tab to see where help is needed.

Code Guidelines

  • Keep your code clean and readable.
  • Follow the coding style used in the project.
  • Write descriptive commit messages.
  • Include tests for new functionality if applicable.
  • Make sure your code builds and passes all tests before submitting a PR.

Pull Request Process

  1. Ensure your changes pass existing tests and do not introduce regressions.
  2. Ensure your branch is up to date with the main or dev branch.
  3. Submit a pull request with a clear description of your changes.
  4. Wait for review and respond to feedback.

Reporting Issues

When reporting bugs or issues, please include:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected vs. actual behavior.
  • Screenshots or logs if available.
  • Your environment (OS, version, etc.).

Code of Conduct

Please be respectful and constructive in all interactions.

We follow a Code of Conduct to ensure a welcoming community for everyone.

License

By contributing to code-practice, you agree that your contributions will be licensed under the same license as the project.

Thank you again for your interest in contributing!