Skip to content

Latest commit

 

History

History
37 lines (20 loc) · 1.75 KB

File metadata and controls

37 lines (20 loc) · 1.75 KB

CONTRIBUTING.md

Contributing to GitHub Action | Worker

Firstly, thanks for considering contributing to GitHub Action | Worker! It's people like you that make GitHub Action | Worker such a great tool.

Where do I go from here?

If you've noticed a bug or have a feature request, make one! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.

Fork & create a branch

If this is something you think you can fix, then fork GitHub Action | Worker and create a branch with a descriptive name.

A good branch name would be (where issue #325 is the ticket you're working on):

git checkout -b 325-contribution-guidelines

Get the test suite running

Now, run the test suite to ensure that everything is working as expected.

Make your changes

Here's the most fun part - make your changes. Make sure to keep the code style consistent and stick to the project's guidelines. Also, make sure to write tests that show your feature or bug fix works as expected.

Create a pull request

Once your changes and tests are done, commit and push your branch. Then create a pull request with your changes. Please provide as much detail as possible in the PR description. Describe the changes you made, why you made them, how to test them, and anything that might be a potential issue.

Important: By submitting a patch, you agree to allow the project owner to license your work under the terms of the MIT License.

That's it!

You're done! Wait for feedback or approval of your changes from the project maintainers and celebrate your success. Your changes will make GitHub Action | Worker even better for everyone.