Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

89 lines (62 loc) · 2.93 KB
Raw

Contributing to Weather App

Thank you for taking the time to contribute to the Weather App! Your help is highly appreciated. Follow the guidelines below to ensure smooth collaboration.

Table of Contents

  1. How Can I Contribute?
  2. Development Guidelines
  3. Issues and Feature Requests
  4. License

How Can I Contribute?

Reporting Bugs

If you find a bug:

  1. Check if the issue already exists in the issues section.
  2. If not, create a new issue with a clear title and detailed description.
  3. Include steps to reproduce, expected behavior, and actual behavior.
  4. Add relevant screenshots or logs if possible.

Suggesting Enhancements

If you have a suggestion to improve the Weather App:

  1. Check the issues section to see if your suggestion is already being discussed.
  2. If not, create a new issue describing your enhancement idea and explain why it would be beneficial.
  3. Be specific about how the feature should work and its impact on the project.

Pull Requests

When submitting a pull request (PR):

  1. Fork the repository.
  2. Create a new branch (use a meaningful name like feature/add-new-feature or bugfix/issue-123).
  3. Make your changes, following the Code Style guidelines.
  4. Ensure that the app runs correctly and passes any existing tests.
  5. Commit and push your changes.
  6. Open a PR to the main branch with a detailed description of your changes and the issue it addresses.
  7. Link any related issues in your PR description.

We encourage small, focused PRs that are easier to review and discuss.

Development Guidelines

Setting Up Your Environment

  1. Fork the repository and clone your fork:

    git clone https://github.com/YOUR-USERNAME/weather-app.git
cd weather-app

  2. To run this project locally on your machine, open the index.html file in your web browser.

  3. The app should now be running on http://localhost:3000.

Code Style

To keep the codebase clean and readable:

  • Follow the existing coding style.
  • Use meaningful variable and function names.
  • Keep functions small and focused.
  • Comment your code where necessary.
  • Remove any unused code before submitting a PR.

Issues and Feature Requests

We track all issues and feature requests using GitHub issues. To create a new issue, visit the issues section and click on "New Issue."

  • Be descriptive and specific.
  • Include relevant screenshots or logs.
  • Tag your issue with appropriate labels (e.g., bug, enhancement).

License

By contributing to the Weather App, you agree that your contributions will be licensed under the MIT License.