Skip to content

Latest commit

 

History

History
118 lines (83 loc) · 4.55 KB

contributing.md

File metadata and controls

118 lines (83 loc) · 4.55 KB
Raw

Contributing to CosmoXplore 🚀

Thank you for considering contributing to CosmoXplore! We're excited to have you on board. Here are some guidelines to help you get started. Please read these steps carefully to ensure a smooth contribution process.

How to Contribute

  1. Fork the Repository 🍴

  2. Clone the Forked Repository 📂

    git clone https://github.com/your-username/cosmoXplore.git
cd cosmoXplore

  3. Create a New Branch 🌿

    • It's good practice to create a new branch for your work. This makes it easier to manage and track your changes.
    git checkout -b my-new-feature

  4. Make Your Changes ✨

    • Make the necessary changes to the codebase.
    • Ensure your code follows the project's coding standards and guidelines.

  5. Stage and Commit Your Changes 📝

    • Add your changes to the staging area: 
      git add .
    • Commit your changes with a descriptive message. Use the -s flag to sign off your commit: 
      git commit -s -m "Add feature XYZ"

  6. Push Your Changes 🚀

    • Push your changes to your forked repository: 
      git push origin my-new-feature

  7. Create a Pull Request 🔄

    • Go to your forked repository on GitHub.
    • Click the Compare & pull request button.
    • Provide a clear and descriptive title for your pull request.
    • Explain your changes in the description. Include any relevant details or issues that your changes address.
    • Submit the pull request.
Alternatively use GitHub Desktop

1. Open GitHub Desktop

Launch GitHub Desktop and log in to your GitHub account.

2. Clone the Repository

If you haven't cloned the ResourceHub repository yet, you can do so by

  1. Clicking on the "File" menu and selecting "Clone Repository."
  2. Choose the ResourceHub repository from the list of repositories on GitHub and clone it to your local machine.

3. Switch to the Correct Branch

  1. Ensure you are on the branch that you want to submit a pull request for.
  2. If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

4. Make the desired changes

Make your changes to the code or files in the repository using your preferred code editor.

5. Commit Changes

  1. In GitHub Desktop, you'll see a list of the files you've changed.
  2. Check the box next to each file you want to include in the commit.
  3. Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively.
  4. Click the "Commit to " button to commit your changes to the local branch.

6. Push Changes to GitHub

After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

7. Create a Pull Request

  1. Go to the GitHub website and navigate to your fork of the ResourceHub repository.
  2. You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

8. Review and Submit

  1. On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
  2. Once you're satisfied, click the "Create pull request" button to submit your pull request.

9. Wait for Review

Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the ResourceHub repository.

Congratulations on successfully submitting your PR to our project! 🎉

If you find ResourceHub useful, please consider giving it a star! ⭐️

Guidelines

  • Write Clear Commit Messages: Keep your commit messages concise but informative.
  • Follow Code Standards: Ensure your code adheres to the project's coding standards.
  • Test Your Changes: If applicable, make sure to test your changes before submitting a pull request.
  • Stay Updated: Pull the latest changes from the original repository before starting your work to avoid conflicts. 
    git pull upstream main

Need Help? 🤔

If you have any questions or need further assistance, feel free to open an issue in the repository or reach out to the maintainers. We're here to help!

Happy coding! 🎉

CosmoXplore Team