Skip to content

Latest commit

 

History

History
89 lines (56 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

89 lines (56 loc) · 3.72 KB
Raw

Clima Contribution Guidelines 🚀

Welcome Contributors! 👋

Thank you for considering contributing to Clima, the user-friendly weather app. Your contributions are valuable, and we appreciate your effort to make Clima even better. Before you get started, please take a moment to read our contribution guidelines.

How to Contribute 🤝

  1. Fork the Repository:

    • Fork the Clima repository to your GitHub account by clicking on the "Fork" button at the top right corner of this page.

  2. Clone the Repository:

    • Clone your forked repository to your local machine using the following command: 
      git clone https://github.com/your-username/your-project.git
cd your-project

  3. Create a Branch:

    • Create a new branch for your contribution. Choose a meaningful branch name related to the feature or fix you are working on. 
      git checkout -b feature/your-feature

  4. Setting Up API Keys:

    • Follow the installation instructions to obtain and set up your Google Maps API Key and OpenWeather API Key. Add them to the appropriate configuration file or class.

  5. Make Changes:

    • Implement your feature or fix in the codebase. Ensure that your changes follow the coding style and conventions used in the project.

  6. Run Tests:

    • Run tests to make sure your changes do not introduce new issues. If applicable, add tests for the new features or fixes.

  7. Documentation:

    • Update the README or any relevant documentation if your changes impact the user experience or installation process.

  8. Commit Changes:

    • Commit your changes with a clear and concise commit message that describes the purpose of your changes. 
      git commit -m "Add feature: your feature description"

  9. Push Changes:

    • Push your changes to your forked repository on GitHub. 
      git push origin feature/your-feature

  10. Create a Pull Request:

    • Open a pull request (PR) from your forked repository to the main Clima repository. Provide a detailed description of your changes and the purpose of the PR.

Contribution Responsibility 🌐

Be Respectful:

Be respectful to others in the community. Constructive criticism is encouraged, but avoid any form of harassment, discrimination, or offensive behavior.

📋 Coding Standards:

Follow the coding style and conventions used in the project. Consistency in code makes it easier for others to review and maintain.

🧪 Testing:

If you are introducing new features, ensure that appropriate tests are added. If fixing bugs, make sure to add tests that cover the fixed scenarios.

📝 Documentation:

Update relevant documentation to reflect your changes. This includes the README file, inline comments, or any other user-facing documentation.

🌿 Branch Naming:

Use meaningful branch names that reflect the purpose of your changes. Prefix your branch with feature/ for new features or bugfix/ for bug fixes.

🔄 Pull Request (PR) Etiquette:

Provide a clear and detailed description of your changes in the PR. If your changes address any existing issues, reference the issue number in your PR description.

🕵️‍♂️ Review Process:

Be open to feedback and participate in the review process. Make necessary updates based on feedback and engage in discussions to improve the quality of your contribution.

🔐 Security:

If you discover any security vulnerabilities, please report them privately to the project maintainers.

Thank You! 🌟

Thank you for contributing to Clima! Your efforts help make this weather app a valuable resource for users. If you have any questions or need assistance, feel free to reach out to the maintainers. Happy coding! 🚀