Note: This guide is for developers. If you are looking to contribute as a project manager, UI designer or UX researcher, please join our organization as a volunteer and then request to join our team!
Thank you for investing your time to our project. Anything you contribute will be reflected on our repository at hackforla/civictechjobs.
Before starting, make sure you read our code of conduct. Also, consider joining our team as a volunteer, especially if you enjoyed contributing to us. This gives you access to our developer meetings and slack channel so that you can influence the direction of the project on a much greater level.
This guide outlines the three ways you can contribute to us as a developer: creating issues, resolving issues, or reviewing a pull requests as either a team member or freelancer.
Pro tip: Use the table of contents in the top-left corner to jump to specific sections of this guide.
Is this your first time working on open source projects? Check out this video series.
Note: "(team member)" and "(freelancer)" are used at the beginning of an instruction to identify a step specific to one or the other.
Locate the appropriate template for your issue from the new issue screen or by clicking the New Issue button from the Issues tab. The Blank Issue or the more detailed form version are always appropriate.
(team member) If you need help, feel free to consult your development lead or other members of the team.
Note: Make sure to check out our installation instructions to set up your development environment before working on any issues!
- Find a developer issue to work on from our prioritized backlog. (Hint: look for the
frontendorbackendlabel). Thesizelabel will signal the amount of work the issue might involve, with a higher number indicating greater work. We encourage you to take the topmostfrontendorbackendissue, as they are arranged by priority by role. - Indicate you are working on the issue as follows:
- (team member) Assign yourself to the issue. (Hint: see step 4 of this GitHub article.)
- (freelancer) If you expect the issue will take more than a day to complete, add a comment to the bug indicating you are working on the bug
- (team member) Move the issue from the prioritized backlog to the in progress column. (Hint, see step 5 of this GitHub article.)
- From your local fork, create a branch off of main.
- Make changes on that branch for your issue.
- Create a pull request from your fork. After you had opened the pull request, there will be instructions on the pull request template for you to follow.
- Check that all the automated checks have passed. This is at the bottom of the pull request.
- Done! Now just wait for a team member to get back to you with feedback on your changes!
(team member) To take on another issue, please ask the development lead for an appropriate additional issue to take on.
Important note 1: We do not want to be flooded with pull requests! Please, do NOT take on another issue or open a second pull request until your current pull request and linked issue are resolved by a team member.
Important note 2: Do not directly contact the team to review your pull request unless it has been over 72 hours since the pull request was opened. As an open-source project, the team contribute to the project in their free time, which varies from week to week, day to day. Feel free to ask any questions, however!
To review code, please take a look at this guide from another project. Not all the information there will be relevant to this project, but it should nonetheless get you started.
1. error: insufficient permission for adding an object to repository database
You must have created a new file, through Docker. Since this file "belongs" to the container, you need to transfer permission by running,
sudo chown -R $USER:$USER .. (See step 3 for more info.)