Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 3.04 KB

Contributing to EazyReach

We appreciate your interest in contributing to EazyReach! To make the process smooth and efficient, please follow the guidelines below.

Table of Contents

Introduction

EazyReach is a revolutionary platform aimed at empowering citizens, reducing poverty, and addressing youth unemployment in Nigeria. The project is built with React and TypeScript, and follows a well-organized folder structure to ensure scalability and maintainability. Your contributions will help enhance the platform and support its mission.

How to Contribute

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on our GitHub repository. Provide as much detail as possible, including steps to reproduce the problem and any relevant screenshots.

Feature Requests

To propose new features, open a new issue and describe the feature in detail. Explain how it would benefit the project and provide any relevant use cases or examples.

Code Contributions

  1. Fork the Repository: Create a personal copy of the repository by forking it on GitHub.
  2. Clone Your Fork: Clone your forked repository to your local machine: 
    git clone https://github.com/AJ1732/easy-reach.git
cd easy-reach
  3. Create a New Branch: Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  4. Make Changes: Implement your changes or new features.
  5. Write Tests: Ensure that your changes are covered by tests.
  6. Commit Your Changes: Commit your changes with a clear and concise message: 
    git add .
git commit -m "Add feature/describe the changes"
  7. Push to Your Fork: Push your changes to your forked repository: 
    git push origin feature/your-feature-name
  8. Open a Pull Request: Navigate to the original repository on GitHub and open a pull request from your branch. Provide a clear description of your changes and any relevant details.

Development Guidelines

  • Coding Standards: Follow the existing coding style of the project.
  • Documentation: Update relevant documentation when making changes.
  • Testing: Write tests for new features and bug fixes. Ensure all tests pass before submitting a pull request.
  • Commit Messages: Use clear and descriptive commit messages. Follow the format type(scope): description (e.g., feat(auth): add user login functionality).

Submitting Changes

Once your pull request is opened, it will be reviewed by the maintainers. They may request changes or improvements. Be prepared to make adjustments based on feedback. We aim to merge pull requests promptly once they meet the project's standards.

Thank you for contributing to EazyReach! Your efforts help make a difference.