Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 4.32 KB

CONTRIBUTING.md

File metadata and controls

75 lines (50 loc) · 4.32 KB
Raw

Contributions Guidelines

If you've got the coding idea and want to contribute to DEV-G EdTech's development, this section provides guidelines on how to fork the repository, create branches, and submit pull requests.

  • Find issues labeled by other contributers and the project admin. Visit in our issue tracker to start contributing. You can also create your own issue from your end if you find such issue

Make Your Changes:

  • Now you're ready to dive into the code! Open the project in your favorite code editor.
  • Make your changes to the files following the project's coding conventions. (If there are no specific conventions documented, follow common JavaScript and React best practices.)

Test the change you made :

  • Run the development server (npm run dev) and test your modifications thoroughly. Make sure your changes don't introduce any new bugs or break existing functionalities.

Commit Your Changes:

  • Use Git to track your changes. Stage the modified files using git add <filename> (or git add . to stage all changes).
  • Commit your staged changes with a descriptive commit message using git commit -m "Your informative message here".

Push Your Changes to Your Fork:

  • Push your committed changes to your forked repository on GitHub using:

    git push origin master

Create a Pull Request:

  • Go to your forked repository on GitHub.
  • Click on the "Pull requests" tab and then "New pull request" button.
  • Select the branch containing your changes from the "Head" branch dropdown.
  • Leave the "Base" branch as "master" (assuming you're targeting the main codebase).
  • Write a clear and concise title and description explaining your changes and their purpose.
  • Click "Create pull request" to submit your changes for review.

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the iemhacks_DEV-G repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the iemhacks_DEV-G repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • 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 Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. 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:

  • Go to the GitHub website and navigate to your fork of the iemhacks_DEV-G repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Submit:

    • 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.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Review and Feedback:

  • The project maintainers will review your pull request and might request clarifications or suggest improvements.
  • Address any feedback promptly and make any necessary adjustments.
  1. Merging Your Changes:
  • Once your pull request is reviewed and approved, the maintainers will merge your changes into the main DEV-G EdTech codebase. Congratulations, you've become a contributor! 🎉🎉

⭐️ Support the Project If you find this project helpful, please consider giving it a star on GitHub! Your support helps to grow the project and reach more contributors.