Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

45 lines (33 loc) · 2.67 KB
Raw

Contributing to Instabot

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

How can I help the project?

You can:

  • Put the star into the Instabot main repository. To do this, click on the star here https://github.com/instagrambot at top right corner. Mind that GitHub registration is required (for free).
  • Login to Telegram Group and help newcomers to understand the installation and configuration of Instabot.
  • Tell everywhere about our project! It will be enough to throw off the link: https://instagrambot.github.io.
  • Find bugs and describe them in Issues section, be sure to attach the screenshots and commands that you entered. This will help correct these errors and make Instabot better!
  • If you are a developer, correct these bugs and errors! Do this via Pull Request, don't forget the PEP8 standard.
  • If you have a brilliant Instabot usage example or even the independent project connected with instagram, tell us about it!

Adding the new docs

If you want to add a new documentation page in any language please follow the guide below.

  1. If your docs have not been written in english, please translate your doc in English too and add it into en/ folder.
  2. Make sure that your doc is written descriptive enough. If you use pictures, please upload them into img/ folder.
  3. Add the link to your doc into the existing docs to make other users find your page.
  4. Create pull request with your docs.

Translate the Docs into your language

  1. Fork the repository.
  2. Create a folder with the name of your country in the abbreviation.
  3. Copy all the files from the /en/ folder to your earlier created folder.
  4. Translate the files into your language, leaving the file structure of the previous one (paragraphs etc).
  5. Add the link to your docs in the main README.md file. Don't forget to add the flag emoji!
  6. Create pull request.

Thank you for supporting the project!

For Developers

Install the dependencies using pipenv: pipenv install

See .travis.yml for the most up to date test and lint commands.

We use pre-commit to keep a consistent code style, so pip install pre_commit and run

pre-commit install  # only need to do this once!

to install the hooks. These will then automatically run upon each commit.