CONTRIBUTING.md

Contributing to codershubinc/open-api

Thank you for considering contributing to our project! We appreciate your time and effort in helping us improve. Please follow these guidelines to ensure a smooth contribution process.

Code Style

• Follow the existing code style and conventions.
• Use meaningful variable and function names.
• Write clear and concise comments where necessary.
• Ensure your code is properly formatted and linted.

Testing

• Write tests for any new features or bug fixes.
• Ensure all tests pass before submitting a pull request.
• Use a consistent testing framework and methodology.

Pull Request Process

1. Fork the repository and create your branch from main.
2. Make your changes in the new branch.
3. Ensure your code passes all tests and adheres to the code style guidelines.
4. Submit a pull request with a clear description of your changes and the problem they solve.

Reporting Issues

If you encounter any issues or have feature requests, please follow these steps:

1. Check the existing issues to see if your problem has already been reported.
2. If not, create a new issue with a clear and descriptive title.
3. Provide as much detail as possible, including steps to reproduce the issue, expected behavior, and any relevant screenshots or logs.

File Structure

The project follows a structured file organization to maintain clarity and ease of navigation. Below is an overview of the file structure:

root
├── src
│   ├── controllers
│   │   ├── api
│   │   │   ├── v0.1
│   │   │   └── v1.0
│   │   └── homePageApi
│   ├── lib
│   │   └── data
│   │       └── api
│   │           └── v1.0
│   │               └── country
│   ├── routes
│   │   ├── api
│   │   │   ├── v0.1
│   │   │   └── v1.0
│   │   └── homePage.routes.js
│   └── utils
│       ├── asyncHandler.js
│       └── func
│           └── Random.js
├── .gitignore
├── index.js
├── package.json
└── vercel.json

Thank you for your contributions!

The codershubinc/open-api Team @codershubinc Swapnil Ingle