|
| 1 | +# Contributions |
| 2 | + |
| 3 | +## New Contributors |
| 4 | + |
| 5 | +Thank you for taking the time to contribute to this repo! This project is actively in use with our |
| 6 | +clients and requires the help of volunteers like yourself to maintain and continue to foster this |
| 7 | +project’s growth. Every contribution helps and credit is always given! |
| 8 | + |
| 9 | +To get started contributing to this project, please email <bpsf@gmail.com>. An exec on the team will |
| 10 | +send you a Slack invite and will onboard you onto our project. |
| 11 | + |
| 12 | +# Roles |
| 13 | + |
| 14 | +We have two roles on the maintenance team: Blueprint Software Foundation (BSF) executive and |
| 15 | +contributors. |
| 16 | + |
| 17 | +## Blueprint Software Foundation executive member |
| 18 | + |
| 19 | +BSF is an overarching organization responsible for the upkeep of projects shipped by UW Blueprint. |
| 20 | +As of writing, BSF is composed of 3 executives: 2 alumni and a UW Blueprint president. |
| 21 | + |
| 22 | +Executives are responsible for maintaining communications with clients and with UW Blueprint |
| 23 | +regarding maintenance projects and onboarding new projects onto BSF. They are also responsible for |
| 24 | +coordinating work on tasks/issues and onboarding contributors. |
| 25 | + |
| 26 | +## Contributors |
| 27 | + |
| 28 | +Much of the fruitful maintenance and upkeep work on projects will be due to our wonderful |
| 29 | +contributors! Contributors will work with execs in prioritizing and planning maintenance work and |
| 30 | +shipping the work to our clients. As of writing, **contributors will be sourced from UW Blueprint |
| 31 | +alumni** but we are planning on opening up contributions to those not part of UW Blueprint. |
| 32 | + |
| 33 | +# Contribution workflow |
| 34 | + |
| 35 | +Please follow the following steps in order to productively contribute to this repository. |
| 36 | + |
| 37 | +## Step 1: Fork the repo |
| 38 | + |
| 39 | +On the repository’s main page, click ‘Fork Repo’ at the top of the page. |
| 40 | + |
| 41 | +## Step 2: Configure your environment |
| 42 | + |
| 43 | +Once you have Notion access, take a look at the README.md file, |
| 44 | +[development guidelines](https://www.notion.so/uwblueprintexecs/Development-processes-a0313f2bef9941fc8752c8e7b5be5e70) |
| 45 | +and |
| 46 | +[engineering best practices](https://www.notion.so/uwblueprintexecs/READ-Best-Practices-Engineering-3174edea363b4d4896af8dfc461cfd9c) |
| 47 | +to set up your environment. |
| 48 | + |
| 49 | +## Step 3: Connect with people |
| 50 | + |
| 51 | +As mentioned above, if you are not already on our Slack, please email <bpsf@gmail.com>. Once added, |
| 52 | +please talk to the execs on which issues or features are highest priority. This will be available as |
| 53 | +a Notion board as well. |
| 54 | + |
| 55 | +Once an issue is chosen, discuss with fellow contributors and execs on Slack on how you plan on |
| 56 | +approaching the issues. We will subsequently assign you the issue and you can get cracking! |
| 57 | + |
| 58 | +## Step 4: Prepare PR |
| 59 | + |
| 60 | +Clone your fork locally and start to make your changes. Small changes are always greater than huge, |
| 61 | +breaking changes! Make sure that you test a variety of situations before you push your change to |
| 62 | +your fork! |
| 63 | + |
| 64 | +## Step 5: Pass PR review |
| 65 | + |
| 66 | +Once you feel confident that your change addresses the issue/feature spec, sync your fork with the |
| 67 | +main repository and open up a PR on the main repo from your fork. Please provide a detailed |
| 68 | +description of your change and ask for the reviews of an exec/designated contributor. |
| 69 | + |
| 70 | +Please be cognizant of an executive’s relatively limited time. Reviews may take longer than you |
| 71 | +would expect! Use Slack wisely to ensure that you can get a review in a timely manner. |
| 72 | + |
| 73 | +# Thank you! |
| 74 | + |
| 75 | +We want to thank the following individuals for their tireless contributions: |
| 76 | + |
| 77 | +- Oustan Ding |
| 78 | +- Carelynn Tsai |
| 79 | +- Vedant Patel |
| 80 | +- Angela Dietz |
| 81 | +- Anish Aggarwal |
| 82 | +- Christian Chan |
| 83 | +- Emilio Mena |
| 84 | +- Jihad Bunkheila |
| 85 | +- Bonnie Chin |
| 86 | +- Anthea Tawiah |
| 87 | +- Charmaine Wang |
| 88 | +- Jeffrey Zhang |
| 89 | +- Amanda Guo |
| 90 | +- Andy Lee |
| 91 | +- Jennifer Tsai |
0 commit comments