Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (45 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

58 lines (45 loc) · 2.4 KB

Make your contribution!

Any help is welcome and highly appreciated! If you want to contribute to the repository, the following instructions will help you get started...

Development

Necessary tools

Getting to work

  1. Fork the repository is on your GitHub account and clone install it on your computer:

    git clone https://github.com/YOUR_USERNAME/iOS-training-projects.git
cd iOS-training-projects/

  2. Add the remote upstream:

    git remote add upstream https://github.com/ssukharev/iOS-training-projects

  3. Switch to the Develop branch:

    git checkout develop

    or create new branch with your name:

    git checkout -b YOUR_BRANCH_NAME main

  4. Add completed work or other changes

    • Be sure to follow the design guidelines.
    • If you need to update your fork, you can do so by doing a rebase with upstream: 
      git fetch upstream
git rebase upstream/main
git push origin BRANCH_NAME -f

Design recommendations

  • All commits must follow the naming convention
  • Pull requests with commits that do not comply with this standard will not be accepted.
  • Please make meaningful commit names or combine them (using squash) before opening the pool request.
    • Do not merge commits after someone has started checking your changes.
  • Always use rebase for your commits to the current main branch. Do not use merge main in your branch.
  • You are responsible for keeping your branch up to date. Your work will not be accepted unless it is migrated from the latest main branch.
  • You can create a "draft" of the pull request in advance to get feedback on your work.
  • Do not overload your work with unnecessary files that do not affect the understanding and performance of the completed task.
  • To add comments to your work that you consider important for its completion, use README.md the files are in the root of their folder.