Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 2.71 KB

Contributing.md

File metadata and controls

67 lines (50 loc) · 2.71 KB
Raw

Contributing to Galactic Mining Hub

Thank you for considering contributing to the Galactic Mining Hub! We appreciate your interest in helping us improve this advanced machine learning platform for space mining exploration. Please follow the guidelines below to ensure a smooth contribution process.

Table of Contents

Getting Started

  1. Fork the repository to your own GitHub account.
  2. Clone the repository to your local machine: 
    git clone https://github.com/YOUR_USERNAME/ISRO_Mining_Site_FINAL_APP.git
  3. Set up the project by following the instructions in the README.md file.
  4. Make your changes and implement the features or fixes you want to contribute.
  5. Test your code to ensure everything works as expected.

Opening a Pull Request

In brief:

  • Commit your changes and ensure your commit messages adhere to the guidelines.
  • Create a new branch for your changes: 
    git checkout -b <branch_name>
  • Open a pull request and provide a clear description of the changes you've made.

Contribution Guidelines

  • We welcome contributions such as new features, bug fixes, enhancements to existing features, and improvements to documentation.
  • Be respectful and constructive when interacting with other contributors.
  • Always test your changes thoroughly before submitting a pull request.
  • Include a clear and descriptive title for your pull request summarizing your changes.
  • If your pull request addresses an existing issue, mention the issue number in the title or description (e.g., "Fixes #42").

Commit Messages

  • Use meaningful commit messages related to your changes.
  • Prefix your commit messages with the following:
    • fix: for bug fixes.
    • feat: for new features.
    • docs: for documentation updates.
    • chore: for miscellaneous changes.

Creating Issues

  • Use a clear and descriptive title for your issue.
  • Provide detailed information about the issue, including:
    • Steps to reproduce the problem.
    • Expected and actual results.
    • Any relevant screenshots or error messages.
  • When suggesting new features, provide a detailed description of the feature and its potential benefits.

Acknowledgments

If you enjoy working with us, please give the project a ⭐ star! Your support means a lot and encourages further contributions.

Thank you for your interest in contributing to the Galactic Mining Hub! Your contributions help enhance the capabilities of this project.

Happy coding! 🌌