Skip to content

Latest commit

 

History

History
44 lines (23 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

44 lines (23 loc) · 2.33 KB
Raw

Contribution Guide

Introduction

Thank you for considering contributing to our project! This guide will help you understand how you can be part of this open-source journey and improve the project with your ideas, bug reports, fixes, and new features.

This project is open to all kinds of contributions - from beginners to seasoned developers. Let's make this project better together!

Ways to Contribute

There are many ways you can contribute:

  1. Report bugs: File a bug report if you find any issues. Please check the existing issues before creating a new one to avoid duplicates.

  2. Suggest a feature: If you have an idea to improve the project, please open a new issue, select the Feature Request template, and describe your idea.

  3. Improve documentation: Good documentation makes a great project. If you find anything that can be improved or is missing in the documentation, feel free to make updates.

  4. Contribute to the code: You can improve existing code or add new features. Check the 'Help Wanted' and 'Good First Issue' labels for issues that you can work on.

Getting Started

  1. Fork the repository: The first step to contribute is to fork the repository.

  2. Clone the forked repository to your local machine: You can use the command git clone https://github.com/marvinIsSacul/mylms-timetable-plus

  3. Create a new branch: After cloning the repository, navigate into it and create a new branch where you'll make your changes. Use the command git checkout -b branch-name

  4. Make your changes: Edit files, fix bugs, or add features in your new branch.

  5. Commit your changes: Once you've made changes, commit them with a clear and concise commit message. You can do this with the command git commit -am "Your descriptive commit message"

  6. Push your changes to the remote repository: You can do this with the command git push origin branch-name

  7. Open a pull request: Navigate to the original repository and click on "New Pull Request". Choose your fork and select the branch you worked on. Click "Create Pull Request".

Coding Standards

Please follow these coding standards when contributing to the project:

  • Use clear and concise comments to explain your code.
  • Ensure that your code is properly indented and formatted (using npm run lint).
  • Use descriptive function and variable names.