-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #89 from AbhineshJha/contri
Added CONTRIBUTION.md file
- Loading branch information
Showing
1 changed file
with
70 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# 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](https://github.com/virtuo-learn/issues) 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.** | ||
|
||
```bash | ||
|
||
git clone https://github.com/your-username/repository-name.git | ||
|
||
``` | ||
|
||
3. **Create a new branch for your changes.** | ||
|
||
```bash | ||
|
||
git checkout -b feature/your-feature | ||
|
||
``` | ||
4. **Make your changes and commit them with a clear and concise commit message.** | ||
|
||
```bash | ||
|
||
git commit -m "Add your message here" | ||
|
||
``` | ||
5. **Push your changes to your fork on GitHub.** | ||
|
||
```bash | ||
|
||
git push origin feature/your-feature | ||
|
||
``` | ||
|
||
6. **Open a pull request on the main repository with a detailed description of your changes.** | ||
|
||
# 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]. |