Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (54 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

83 lines (54 loc) · 2.28 KB

Contribution Guidelines

Thank you for your interest in contributing to DChama! We welcome contributions from everyone. To ensure a smooth and efficient collaboration, please follow these guidelines.

How to Contribute

1. Fork the Repository

First, fork the DChama repository to your GitHub account.

2. Clone Your Fork

Clone your forked repository to your local machine:

git clone https://github.com/YourUsername/decentralized-chama.git
cd decentralized-chama

3. Create a New Branch

Create a new branch for your feature or bug fix. Use a descriptive name:

git checkout -b feature/your-feature-name
# or
git checkout -b bugfix/issue-description

4. Make Your Changes

Implement your changes, ensuring they adhere to the project's coding style and best practices.

5. Test Your Changes

If you're fixing a bug, please add a test that reproduces the bug before your fix and passes after your fix. If you're adding a new feature, please add relevant tests.

6. Commit Your Changes

Commit your changes with a clear and concise commit message. Follow the Conventional Commits specification for your messages.

git commit -m "feat: Add new feature"
# or
git commit -m "fix: Resolve issue with ..."

7. Push Your Branch

Push your changes to your forked repository:

git push origin feature/your-feature-name

8. Create a Pull Request

Go to the original DChama repository on GitHub and open a new Pull Request.

  • Provide a clear title and description for your Pull Request.
  • Reference any related issues.
  • Ensure your branch is up-to-date with the main branch of the upstream repository.

Coding Style

  • Follow the existing code style.
  • Use meaningful variable and function names.
  • Keep functions small and focused.
  • Add comments where necessary to explain complex logic.

Reporting Bugs

If you find a bug, please open an issue on GitHub.

  • Provide a clear and concise description of the bug.
  • Include steps to reproduce the bug.
  • Mention your operating system, browser, and any relevant software versions.

Feature Requests

If you have an idea for a new feature, please open an issue on GitHub.

  • Describe your feature request in detail.
  • Explain why you think this feature would be beneficial.

Thank you for contributing!