When contributing to Primero, either as part of the DAO, or as a traditional open-source contribution, it is necessary to follow a set of guidelines. This helps ensure that any new contributions meet existing code standards, and are as likely as possible to be merged into the upstream repository.
In these instructions, we walk through the steps that are required to add a new feature to Primero.
If you are contributing as part of the DAO, you first need to create a proposal, which will be voted upon by the DAO members for approval.
You will then work on your feature and submit a Pull Request to the Primero GitHub Repository.
Warning
Even if your proposal is approved by the DAO, it is still subject to code review by the Primero development team. This is a mandatory step, and you will not receive any payout if you do not pass code review. The Primero development team is not obligated to accept any proposed changes, even if the DAO has approved the proposal.
The following flow chart illustrates the overall process for contributing via the DAO and receiving payment for the associated work.
flowchart TD
Proposal(Create proposal)
--> RefineProposal(Refine proposal)
--> Vote1{{DAO votes on proposal}}
-- Approved --> Begin(Work begins on proposed feature)
Vote1 -- Rejected --> ProposalRejected([Proposal rejected])
Begin --> PR(Pull Request opened)
--> DevTeamReviews{{Primero Development Team reviews code}}
DevTeamReviews -- Dev Team Proposes Changes --> ImplementChanges(Proposed changes are implemented) --> UpdatePR(Pull Request updated with new changes) --> DevTeamReviews
DevTeamReviews -- Dev Team Approves PR --> Report(Report completion of proposal to DAO)
DevTeamReviews -- Dev Team Rejects PR --> CodeRejected([Code rejected])
Report --> Verify(DAO verifies that the proposal has been satisfied by the PR)
--> Vote2{{DAO votes on completed proposal}}
-- DAO Satisfied --> Paid([Funds Paid])
Vote2 -- DAO Not Satisfied --> PR
The forum for submitting proposals is located at: https://unicef.tomars.co/
You can see the guidelines for creating a proposal at the following thread: link
Once you have crafted a proposal and it has been refined and approved, you should set up a development environment if you have not already done so. You can get started by following this guide: Getting Started with Development Environment & Running Primero
Warning
If you anticipate needing to include a new dependency in Primero, this should be brought up at the proposal stage so its merits can be discussed. In general, new dependencies should be avoided, but there are some situations (more likely on the frontend than the backend) where an additional dependency might be accepted. It is very unlikely that a PR which introduces new dependencies without prior discussion will be merged.
Once you have started work on your feature, you should open a PR by following the steps in: Managing Git & Formatting PRs