fedemengo/nodebestpractices

START HERE - Some information!

Opened this issue · 2 comments

I think it could be interesting experimenting with a basic workflow for speeding up/keeping track of what is done, what is in progress and what needs to be done

How?

Start working

  • Assign yourself to the issue you are going to work on (the section you want to translate)
  • Assign yourself in advance to issues that you really want to work on in the future (let's say up to 3)
  • It will be necessary to create new files in sections/
    • if the file hasn't been create yet, copy the original file (e.g. sections/security/avoideval.md to sections/security/avoideval.italian.md) and translate the section on the copy
  • Commit your changes to a personal or task-related branch (e.g. either username, security, issue-x or username-ISSUENUMBER but not italian-translation nor master. I think a personal branch would make more sense)

During the work

  • If you need help clarifying something or for any kind of doubt just go on with your work and ask for a specific review when submitting a PR

When you're done

  • Create a PR for a single section only
    • Follow the template and reference the issue that the PR will close/solve
  • Assign the other contributors as reviewer for your PR
  • Don't merge the PR yourself, but let one of the others contributor to do it
  • The branch on which the PRs should be merged is italian-translation
  • If, after creating the PR, you realized it's not complete just add WIP in the title to prevent a reviewer from merging it

NOTE

The repo we are translating is extremely active, this means that there will probably be always new work to do. If that's the case I guess new sections will be added and you could just create new issues accordingly (for example I haven't created the issues for security and performances yet) by using the template if you think it helps (assign new issues to relative milestone and project).

You can check the progress of each section using milestones and the overall progress in the projects section!

FAQ

Why are we discussing in english if the work consists of translating the repo to italian?
Because it's cool

How are the task in the project section managed?
An issue starts in the To do columns, it automatically moves to In progress when the issue is reopened or when a PR is created, reopened or a review is required for the PR. A task goes to the Done column when the issue is closed or when the PR is merged. Finally the Rejected columns will contains all the PRs that have been closed but not merged

Feedback is extremely important

List of active contributors

@fedemengo @mrcolo @andreaziani

Invite your italian friends to help

Yo, @fedemengo I think that

but let one of the others contributor to do it

should be

but let one of the other contributors do it

Ok let's do it!

I extremely agree with:

Don't merge the PR yourself, but let one of the other contributors to do it;
Because it's cool