Skip to content

Latest commit

 

History

History
70 lines (58 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

70 lines (58 loc) · 3.2 KB

Contributing to Source Code

Introduction

Thank you for your interest in contributing to Mobula. We value the contributions of developers like you and are excited to see your ideas and improvements. This document outlines the process for contributing to the project's source code.

Getting started

  • Fork the Repository: Start by forking the repository to your GitHub account.
  • Clone the Forked Repository: Clone your fork to your local machine to start working on the changes.
git clone https://github.com/MobulaFi/mobula-ui.git
  • Set Up the Development Environment: Follow the instructions in the README to set up your local development environment.

Making Changes

  • Create a New Branch: Create a new branch for your changes. Branch names should be descriptive and reflect the feature or fix you are working on.
git checkout -b feature/your-feature-name
  • Write Code: Implement your feature or fix. Make sure to adhere to the coding standards and guidelines of the project.
  • Write Tests: If applicable, write tests for your code to ensure reliability and prevent future regressions.
  • Run Local Checks: Before submitting your changes, run any linters, formatters, and tests to ensure everything is in order.

Submitting Changes

  • Commit Your Changes: Commit your changes with a clear and concise commit message, explaining what your changes do and why.
git commit -m "feat: Add a brief and descriptive commit message"
  • Push to Your Fork: Push the changes to your forked repository.
git push origin feature/your-feature-name
  • Create a Pull Request (PR): Go to the original repository and create a pull request from your branch. Fill in the PR template, clearly describing the changes and any relevant details.
  • Code Review: Wait for the code review process. Be responsive to feedback and make any requested changes.
  • Merging: Once your PR is approved, a maintainer will merge it into the main codebase.

Guidelines for a Great Contribution

  • Small, Focused Changes: Keep your contributions small and focused. Tackle one issue or feature at a time.
  • Follow Project Conventions: Stick to the coding style, test practices, and commit guidelines of the project.
  • Documentation and Comments: Add comments and update documentation to reflect your changes.
  • Stay Up-to-date: Regularly sync your fork with the main repository to keep up with changes and reduce merge conflicts.

Community and Support

  • Ask Questions: If you're unsure about something, ask in the community chat or discussions.
  • Stay Respectful and Constructive: Treat community members with respect. Provide constructive feedback and be open to receiving it.

Conclusion

Your contributions are crucial to the growth and improvement of Mobula. We appreciate your efforts to make this project better and look forward to your valuable input.