Want to contribute to this repo? That's great! These instructions will help you contribute.
- Always be kind and have empathy for others.
- Follow the GitHub code of conduct.
- Be patient, as this is a volunteer-driven project.
- Post a comment on the GitHub issue you're working on, with details about where you got stuck.
- If no issue applies to your situation, you can create a new GitHub issue.
- You can also ask for help in the Margarita Humanitarian Foundation chat room on Element
- Please follow the Installation steps.
- Please create a new branch and name it with the changes you are making. E.g.
fix-card-sort-order - Make your code changes. You can preview your changes by Running the project locally
- Send us a pull request.
Please ensure your repository is up to date before making a pull request, this project is very active so something may have been changed already! Learn to sync your branch.
We will then review your pull request, during this process you may receive feedback and questions about your request.
We may request or make changes where necessary. Feedback will always be kind, considerate, and constructive! We are very grateful for all contributions!
Fork this repo, then:
git clone <url-to-your-laptopsforfamilies.org-here>
cd laptopsforfamilies.org/
Then,
yarn install
Once you have finished the Installation process you can run the project with
yarn dev
Yes, absolutely! Contributors are certainly allowed to:
- List their contributions on their resumes
- Pin or feature this repo on their GitHub profiles
- Put the project on their portfolio websites as something they contributed to
- Share this repo as an example of something they contributed to
- Say on LinkedIn that they did volunteer work for Margarita Humanitarian Foundation
- Refer to this project in any other way that is honest and ethical
We do have strict ethical standards. Contributors aren't allowed to:
- Remove commit history and say they created the project entirely themselves
- Do anything unethical or dishonest with the project