Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 2.93 KB

contribution-guidlines.md

File metadata and controls

47 lines (28 loc) · 2.93 KB
Raw

Contribution Guidelines

Thank you for considering contributing to Coursefy! I appreciate your interest in helping improve our application. Coursefy is currently in early development and made with only using Godot Engine, requiring refactoring and the establishment of a flexible, robust architecture to facilitate easy upgrades without breaking the existing project for future feature requirements.

Now if you don't know Godot and want to contribute you can do that by reporting issues and proposing new features.

How to Contribute

  1. Fork the Repository: Start by forking the Coursefy repository to your own GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine using the following command: git clone https://github.com/ymanawat/coursefy.git

  3. Create a New Branch: Create a new branch for your contribution. Choose a descriptive name that reflects the nature of your changes: git checkout -b your-feature-name

  4. Make Changes: Make your desired changes or additions to the codebase. Ensure that your changes align with our project's goals and coding standards.

  5. Commit Changes: Commit your changes with clear and concise commit messages that reflect the nature of changes.

  6. Pull Latest Changes: Before pushing your changes, pull the latest changes from the main repository to ensure you are up-to-date: git pull origin master

  7. Resolve Conflicts: If there are any conflicts between your changes and the latest code, resolve them locally on your machine.

  8. Push Changes: Push your changes to your forked repository: git push origin your-branch-name

  9. Create a Pull Request: Go to the original Coursefy repository on GitHub and create a pull request from your forked branch to the main branch of the original repository. Provide a clear and detailed description of your changes in the pull request.

Contribution Guidelines

  • Code Quality: Ensure your code is well-organized, follows best practices, and is properly documented. As the project is current project is made for only working but looking to it for maintaining proper quality.
  • Testing: Properly change the new features or changes you have added to the codebase, also include the picture or video of new feature and fixed bugs in the PR.

What I'm Looking For

  • Bug Fixes: Help me identify and fix bugs in the application.
  • Feature Development: Contribute new features to enhance Coursefy's functionality.
  • Refactoring: Contribute to refactoring efforts to improve code readability and maintainability.
  • Documentation: Improve project documentation, including README files, code comments and guidelines.

Note

Coursefy is in early development, and I appreciate your patience and understanding as we work towards creating a robust and user-friendly application. Your contributions play a vital role in shaping the future of Coursefy.

Thank you for being part of this project!