Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 2.65 KB
Raw

Contributing

Thank you for choosing this repostiroy to contribute 🙂, the following document will show you how to contribute a new autmatation to this repository.

Step 0: Making your project contribution ready

  1. Ensuring the readiness of your code/project
  2. Ensure that your code and project is in a working condition and performs its intended task.
  3. Preparing the README : The README file of your project must contain the following sections:
    • A brief description of the project: What task does this task automate
    • A Section titled Pre-requisites : What will need to be installed on the user's system in order to get your automation running
    • A Section titled How to use : How to go about using your project from the end-user perspective (may as well add pictures/videos explaining them)
    • (Optional)A "Created By" section : This section contain information about the creator/creators of the project (you can also add link to your profile here)

You can also use one of the readme templates available here. (if you didn't find your chosen programming language then you can post it in this issue regarding the same or go an extra mile and add it yoursef if you want to )

Step 1: Contributing an Automation

  1. Look for an existing open issue to work upon or create a new one explaining your idea (just make sure an issue exist before opening a new pull request)

  2. Fork repository (💡bonus tip: don't work on main branch of your fork)

  3. Copy/create project into the forked repo under the 'Automation' folder

  4. Create a Pull Request :

    Create a pull request with proper description to merge your changes into the main repo ( the one hoted by Arsenic )

  5. Keep track of your pull request :

    That’s it!🎉 Wait for your pull request to be approved and merged. If there are any discrepancies, an admin will add a comment requesting you to make the necessary changes and your pull request will have to be updated accordingly.

NOTE 📝:

If you already have an automation and just want it to apper in the Automation with their own repo list, then just send a PR updating the README.md file with link to your repo in the file ( although the automation should still be contribution ready as explaind in step - 0 here )