Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

65 lines (40 loc) · 2.85 KB
Raw

Contributing to MageForge

We appreciate your interest in contributing to MageForge! Please follow the guidelines below to ensure a smooth and effective contribution process.

Submitting a Pull Request

  1. Create an Issue: Start by creating an issue to describe your feature request or bug report. Be sure to include all relevant details.
  2. Fork the Repository: Fork this repository and create a new branch for your work that corresponds to the issue you opened.
  3. Commit Your Changes: Make your changes in the new branch and commit them with clear, descriptive messages.
  4. Open a Pull Request: Submit a pull request to merge your changes into the main branch of this repository.

Coding Standards

  • Magento Coding Standards: Adhere to the Magento Coding Standards throughout your code.
  • Code Validation: Make sure your code is free of errors and warnings.
  • GitHub Actions: Our pipeline will automatically check coding standards using GitHub Actions.

Documentation Guidelines

Licensing

  • License Information: Review the LICENSE file for detailed licensing information.
  • Contribution License: By contributing, you agree that your work will be licensed under the MIT License.

Code Formatting

  • Indentation: Use 4 spaces for indentation.
  • Naming Conventions: Choose meaningful names for variables and functions.
  • Line Length: Keep lines under 80 characters wherever possible.
  • Linting: Run trunk check to lint your code before submission.

VSCode Users

If you use VSCode, our workspace settings, located in .vscode/settings.json, will be applied automatically. We recommend using the Git Commit Message Helper to format your commit messages with the appropriate prefixes based on your GitHub branch name and issue ID.

For example, use: #123 - Commit Message ...

Git Commit Message Helper Demo

Best Practices

  • Comments: Write clear and concise comments.
  • Documentation: Provide descriptions for functions, classes, and parameters.
  • Testing: Thoroughly test your code before submitting it.

Code Review Process

  1. Submit for Review: Once your pull request is ready, submit it for review.
  2. Request a Review: Request a code review from a maintainer.
  3. Address Feedback: Respond to any feedback or requested changes promptly.
  4. Ensure Tests Pass: Make sure all tests pass before your pull request is merged.

Thank you for contributing to MageForge! Your efforts help make this project better for everyone.