CONTRIBUTING.md

Welcome to Modulify's contributing guide

Thank you for investing your time in thinking about contributing to the growth of Modulify! We are happy to say that anything you do to contribute will be properly appreciated and identified in the projects readme and wiki! Also, check out Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

I am new, how can I get started?

Well, first, have a read into the README file. There you'll find everything you need to know about the project! What you should read before getting into contributing:

• Finding ways to contribute to open source on GitHub
• Set up Git
• GitHub flow
• Collaborating with pull requests

Getting started

Issues

Create a new issue

If you spot a problem in the repository, being it the documentation, wiki, code, whatever you find that might need to be changed!

First, search if your issue already exists. If the issue doesn't exist, you can open a new issue using the issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes in a codespace

For more information about using a codespace for working on GitHub documentation, see the github's working in a codespace article.

Make changes locally

1. Fork the repository.

• Using GitHub Desktop:

  • Getting started with GitHub Desktop will guide you through setting up Desktop.
  • Once Desktop is set up, you can use it to fork the repo!

• Using the command line:

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

2. Install PHP 8.2 or above and composer.

3. Create a working branch and start with your changes!

Commit your update

Commit the changes to your branch once you are happy with them.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

• Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
• Don't forget to link PR to issue if you are solving one.
• Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, the author will review your proposal. We may ask questions or request additional information.
• We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
• As you update your PR and apply changes, mark each conversation as resolved.
• If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 the author thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the wiki and readme.