Skip to content

Latest commit

 

History

History
104 lines (63 loc) · 4.35 KB

CONTRIBUTION.md

File metadata and controls

104 lines (63 loc) · 4.35 KB
Raw

Virtuo Learn Contribution Guidelines

Thank you for considering contributing to Virtuo Learn! We welcome contributions from the community to enhance the learning experience for our users.

How to Contribute

We appreciate all kinds of contributions, whether it's reporting issues, suggesting enhancements, or contributing code. Here's how you can get involved:

Reporting Issues

If you come across any bugs, issues, or have suggestions for improvements, please feel free to open an issue on our GitHub repository. Make sure to provide detailed information about the problem or suggestion.

Submitting Pull Requests

We encourage the community to submit pull requests with enhancements or fixes. To contribute code, follow these steps:

  1. Fork the repository on GitHub.

  2. Clone your forked repository to your local machine.

   git clone https://github.com/your-username/repository-name.git
  1. Create a new branch for your changes.
git checkout -b feature/your-feature
  1. Make your changes and commit them with a clear and concise commit message.
git commit -m "Add your message here"
  1. Push your changes to your fork on GitHub.
git push origin feature/your-feature
  1. Open a pull request on the main repository with a detailed description of your changes.

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 Virtuo-Learn repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the Virtuo-Learn 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 Virtuo-Learn repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and 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. 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 Virtuo-Learn repository.

Coding Guidelines

When contributing code, please adhere to the coding guidelines and best practices:

  • Write clear and concise code with appropriate comments.
  • Test your changes thoroughly before submitting a pull request.

Types of Contributions

  1. Feature Requests If you have ideas for new features or improvements, please open an issue on GitHub to discuss it with the community and the maintainers.

  2. Documentation Help us improve our documentation by fixing typos, adding examples, or providing better explanations. Documentation changes can be submitted through pull requests.

  3. Translations If you are fluent in multiple languages, you can contribute by translating the platform into different languages. Follow the same pull request process mentioned above for translations.

Contact

If you have any questions or need further assistance, you can contact us at [email protected].