Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

72 lines (45 loc) · 1.69 KB

How to Contribute 🛠️

Step 1: Find an Issue

Browse the open issues in the main repository and pick one you want to work on. Or create one if you have found a bug or have a feature request.

Step 2: Fork the Project 🍴

Click the "Fork" button on the main page of the repository to make a copy in your own account.

Step 3: Clone the Project 🌿

Clone the Project by HTTPS or SSH and open this localy.

Step 4: Environment 🌿

$ git checkout develop
  • Set up your project by adding your .env variables:
$ npm ci
$ git checkout -b your_branch_name

Step 5: Work on the Task 👨‍💻👩‍💻

Firstly you should run the Back-end project side: https://github.com/ita-social-projects/SpaceToStudy-BackEnd

Make the necessary changes in the code or documentation.

Step 6: Test your code

Make sure that the changes you've made work locally before creating a Pull Request

Step 7: Commit ✅

Add your changes through Git and create a commit with a descriptive message.

$ git add .

Create a Commit

$ git commit -m 'Your descriptive message'

NOTE: Each pull request (PR) should contain only one commit. If you have multiple commits, they need to be squashed.

Step 8: Work Remotely 🌍

When your work is ready and complies with project conventions, upload your changes to your fork:

# Push your work to your remote repository
$ git push -u origin Branch_Name

Step 9: Create a Pull Request ➡️

  • Go to the page of your fork on GitHub and click "New Pull Request".
  • You should create pull request to base develop branch.
  • Verify that the changes are displayed correctly, and then submit your pull request.