Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

69 lines (48 loc) · 2.95 KB
Raw

Contributing to UssdFlow

First off, thanks for taking the time to contribute! UssdFlow is open-source and relies on contributions from the community to improve and grow. Below are guidelines for contributing to this project.

How Can I Contribute?

Reporting Bugs

If you encounter a bug or an issue, please report it by following these steps:

  1. Search Existing Issues: Before opening a new issue, please check if the issue has already been reported.
  2. Open a New Issue: If your issue hasn't been reported, create a new issue in the GitHub Issues section. Please provide detailed information, including steps to reproduce the issue, the expected outcome, and any relevant logs or screenshots.

Suggesting Enhancements

We welcome suggestions to improve UssdFlow. If you have an idea, please submit it as an issue and clearly describe:

  1. The Problem: What problem will the enhancement solve?
  2. Proposed Solution: How will the enhancement address the problem?
  3. Alternatives Considered: What alternatives did you consider?

Pull Requests

If you'd like to contribute code, please follow these steps:

  1. Fork the Repository: Create a fork of the UssdFlow repository.
  2. Clone the Repository: Clone your fork to your local machine. 
    git clone https://github.com/adams-okode/ussd-flow.git
cd ussd-flow
  3. Create a Branch: Create a new branch for your feature or bugfix. 
    git checkout -b feature/your-feature-name
  4. Make Changes: Implement your feature or bugfix. Make sure to follow the coding standards and best practices.
  5. Write Tests: Add tests for your changes to ensure they work correctly.
  6. Commit Changes: Commit your changes with a clear and concise commit message. 
    git commit -m "Add feature/your-feature-name"
  7. Push to Your Fork: Push your changes to your forked repository. 
    git push origin feature/your-feature-name
  8. Submit a Pull Request: Go to the original repository and submit a pull request. Provide a clear description of your changes and why they are necessary.

Code of Conduct

Please note that this project is governed by a Code of Conduct. By participating, you are expected to adhere to it.

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally

Python Style Guide

This project follows the PEP 8 style guide. Please ensure your code adheres to these standards.

Additional Resources

Thank you for contributing to UssdFlow!