Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (54 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

88 lines (54 loc) · 2.31 KB

Contributing to Malas Commit

First off, thanks for taking the time to contribute! 🎉

The following guidelines will help you get started and ensure your contribution is useful to the community.

How to Contribute

  1. Fork the Repository

    • Click the "Fork" button in the top-right corner of this repository to create your copy of the project.

  2. Clone the Repository

    • Clone the forked repository to your local machine:
    git clone https://github.com/your-username/malas-commit.git

  3. Create a New Branch

    • Make sure you're in the project directory and create a new branch to make your changes:
    git checkout -b your-feature-branch

  4. Make Your Changes

    • Implement your feature or bug fix. Ensure that your code adheres to the style guidelines.
    • If you’re fixing a bug, write a test case to prevent future regressions.

  5. Commit Your Changes

    • Commit your changes with a clear and meaningful message. Follow conventional commits to make your commit message consistent:
    git commit -m "feat: add new feature or fix bug"

  6. Push to Your Branch

    • Push the changes to your forked repository:
    git push origin your-feature-branch

  7. Open a Pull Request

    • Go to the original repository and open a Pull Request from your feature branch to the main branch.
    • Include a description of what you have done and why it should be merged.

Guidelines for Contributions

  • Make sure the codebase builds and passes all tests before submitting your PR.
  • Write clear, concise commit messages.
  • If you make changes to the code, update the corresponding documentation.
  • Your code should follow the project’s coding style.

Pull Request Description Template

When submitting a pull request, please follow this template to keep descriptions clear:

### Description of Changes

<!-- Describe the changes made, what functionality or bug was addressed, and why -->

### Related Issues

<!-- Reference any related issues or pull requests -->

### Type of Change

- [ ] Bug fix
- [ ] New feature
- [ ] Refactor
- [ ] Documentation update

### Testing Information

<!-- Detail any tests that have been added or need to be run, and how to run them -->