Skip to content

Latest commit

 

History

History
109 lines (63 loc) · 5.63 KB

CONTRIBUTING.md

File metadata and controls

109 lines (63 loc) · 5.63 KB

Requirements to run the project

  • Ruby
  • Postgres
  • Be adminstrator You need to create the .env file:
 ADMIN_EMAIL=youremail
 ADMIN_EMAIL_ALT=othermail

How to work on this task

  1. Make a comment about your interest on the issue
  2. You will be invited and be assign to the task
  3. Fork the project
  4. Clone the repo with git clone and run rails s to start the project

rake test (run tests and make sure is green)

rails db:migrate (Run the migrations for the database)

rails s (Rodar o projeto)

  1. Make the necessary changes to this issue
  2. Send a pull request
  3. Verify if your changes didn't break the automated tests
  4. A new application will be created to be validated
  5. You will receive feedback from team members
  6. You will send changes until is approved
  7. You get a approve 👍
  8. When the Pull Request is merged, if is a paid task, the payment is send

If you have any doubt or need help just comment and you will be supported

To make simple changes on files

A Fork is a copy of a repository.Forking a repository allows you to freely experiment with changes without affecting the original project.

Steps to fork a Project:

  • Click on button “Fork”
  • The system displays the following screen so that the user can choose a repository to save a project

Fork

After the repository is chosen,the system displays all the project files that you fork, then the user can choose the requested file to edit. Click on the file to open the project files.

s_a

The user has to click on the icon below to edit the project files.

edit_

The system allows the user to edit the file, this way the user can improve and fix errors as desired.

After performing changes, the user must fill in the form “Propose file change”, explain the changes performed in the comment box and click on the button “Propose file change”.

sp pf

The system displays the screen "Comparing Changes" comparing the codes. Then the user has to click on the button "Create a pull request".

comparing

Pull Request allows others users to see the changes that were performed in Github repository. When a pull request is opened, the system allows others users to discuss a topic and analyze a request. Other developers can collaborate with the user’s projects in Github repository.

Steps to Open a Pull Request:

  • Fill in the form with the user's technical comment on future changes
  • Upload the bug image that was found or upload the image/file that shows the improvement
  • Click on button “Create pull request”

pull request

After the Pull Request being created, the system displays a screen with a request and information about a demand.

text correction

After the user has to click on the link below the comment box "Travis" to view the system executing the automated testing integration according to the picture below.

test

When the system finishes the integration process test, every change has to be approved by the project admin. If the admin doesn't approve a change, the admin can request the review of the changes done in the project. For the user to see the feedback, the user has to click on the link “Pull resquest”, select the tab "Created" then the user has to select the pull request that has the review.

request review

The system displays the screen with comments about the pull request review on the tab "Conversation" then the user has to click on the tab “Files changes”.

change pull

The system displays the project edition screen. The user has to click on the icon below to edit the project files.

edit

The system allows the user to edit the file, this way the user can fix errors as suggested by admin. After performing changes, the user must fill in the form “Commit changes”, explain the changes performed in the comment box, select the option “Commit directly to the patch-3 branch” and click on the button “Commit changes”.

edicao do arquivo commit c

After the user commit the project, the project admin has to approve the project so that the project can be integrated with the original project.