CONTRIBUTING.md

How to contribute to AUnlocker

Thank you for investing your time in contributing to our project!

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

New contributor guide

To get an overview of the project, read the README file. Here are some resources to help you get started with open source contributions:

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

Getting started

Issues and Pull requests are the types of contributions we accept.

🐛 Issues

Issues are used to track tasks that contributors can help with.

Create a new issue

If you've found something that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a template. We'll use the issue to have a conversation about the problem you want to fix.

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.

🛠️ Pull requests

A pull request is a way to suggest changes in our repository. You should always review your own pull request first, before marking it as ready for review by others. Make sure that you:

• Use and fill the pull request template.
• Check your changes for grammar and spelling.
• 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, 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 (and any other) changes in your fork, then commit them to your branch.
• If there are any failing checks in your pull request, troubleshoot them until they're all passing.
• If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Make changes

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. Create a working branch and start with your changes!
3. Commit the changes once you are happy with them.
4. When you're finished with the changes, create a pull request.