Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

83 lines (52 loc) · 3.11 KB
Raw

Contributing to Codee

🎉 Thank you for considering contributing to the Codee! 🎉

We welcome contributions from the community to help improve and enhance the project. By following these guidelines, you can contribute effectively and ensure a smooth collaboration process.

Ways to Contribute

There are several ways you can contribute to the Codee:

  • Reporting Bugs: If you encounter any bugs or issues while using the PWA, please submit a detailed bug report, including steps to reproduce the issue and any relevant information.

  • Requesting Features: If you have ideas for new features or improvements, feel free to submit a feature request. Provide a clear description of the proposed functionality and any additional context that might be helpful.

  • Fixing Issues: You can contribute by fixing bugs, implementing new features, or improving existing functionality. Check the issue tracker for any open issues labeled "help wanted" or "good first issue" to get started.

  • Documentation: Improving documentation is always valuable. If you find any gaps or inaccuracies in the documentation, please submit a documentation update.

Getting Started

To contribute to the Codee, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local machine.

    https://github.com/Jonathanthedeveloper/ussd-app

  3. Create a new branch for your contribution.

git checkout -b feature/your-feature-name

  1. Make your changes, following the project's coding guidelines and best practices.

  2. Commit your changes with clear and descriptive commit messages.

  3. Push your branch to your forked repository.

git push origin feature/your-feature-name
  1. Open a pull request against the main branch of the original repository. Provide a clear title and description for your pull request, including any relevant information or references to related issues.

Code Style Guidelines

To maintain code consistency, please follow these guidelines:

  • Use meaningful variable and function names.
  • Format your code consistently using the provided .prettierrc configuration if provided.
  • Write clear and concise comments to explain complex logic or functionality.
  • Follow best practices and patterns used in the existing codebase.

Code Review

Every contribution goes through a review process before being merged into the main repository. The review process helps ensure code quality, adherence to project standards, and compatibility with existing code. Be open to feedback and suggestions from the maintainers and other contributors.

License

By contributing to the Codee, you agree that your contributions will be licensed under the same LICENSE as the project.

Contact

If you have any questions or need further assistance, feel free to reach out to the project maintainers:

Twitter: human_who_codes

Issue Tracker: https://github.com/Jonathanthedeveloper/ussd-app/issues

Thank you for your interest in contributing to the Codee! We appreciate your support and look forward to your contributions.