Skip to content

Latest commit

 

History

History
146 lines (96 loc) · 5.74 KB

CONTRIBUTING.md

File metadata and controls

146 lines (96 loc) · 5.74 KB
Raw

Instructions for Contributors

Want to contribute to this repo? That's great! These instructions will help you contribute.

Be Kind

  • Always be kind and have empathy for others.
  • Follow the GitHub code of conduct.
  • Be patient, as this is a volunteer-driven project.

Stuck? Need Help?

Contribution Workflow

  1. Please follow the Installation steps.
  2. Please create a new branch and name it with the changes you are making. E.g. fix-card-sort-order
  3. Make your code changes. You can preview your changes by Running the project locally
  4. Run yarn format to ensure your code is following our linter and formatter rules. You may have to fix some linting issues manually.
  5. 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!

Important Note On Style

We are using Tailwind and DaisyUI. But if you feel the need to use css there are some guidelines.

  • Avoid the inline style attribute.
  • Avoid css modules unless you are working on a whole page.
  • Use the styled jsx library and follow these conventions.

Note: Styled JSX is scoped, so you can be more free with the class names, just make sure it stayes scoped as for example in the case of sub components or a wrapper component.

<div id="container">
  <div className="my-class">
    // MyComponent is considered scoped
    <MyComponent />
  </div>

  <styled jsx>{`
    .my-class {
      height: 100vh;
    }
  `}</styled>
</div>

JSX/React style guide

We are building a convention to follow here. As an example, use arrow functions while creating components.

const MyComponent = () => {...}

Soon-ish

We are working on a visual style guide. Until then we ask that you try to match the current look and colors when styling. You may receive feedback about changes that aren't yet outlined. Bear with us!

PR Peer Review

We are looking forward to everyone's contributions at all levels

If you feel you want to help by reviewing pull requests, no matter your level:

  1. We're excited to see that!
  2. We ask that you use our peer review checklist in your reviews and comments.

Copy/paste this into your comment:

# Peer Checklist Items

- [ ] Review is clear as to what changes need to be made if any
- [ ] Requests for changes are made as code suggestions whenever possible
- [ ] PR review is submitted with "Request Changes" or "Approved" marked
- [ ] If Review contains multiple suggestions they are in a bulleted list
- [ ] Link to relevant issues if referencing them
- [ ] PR follows [MHF Javascript/React Style Guide](https://margaritahumanitarian.gitbook.io/help-a-family-manual/contributing-to-the-repository/mhf-javascript-react-style-guide)
- [ ] PR follows [MHF CSS Guide](https://margaritahumanitarian.gitbook.io/help-a-family-manual/contributing-to-the-repository/mhf-css-guide)
- [ ] Submitter's comments follow Code of Conduct

Again, we encourage everyone at all levels to participate in this process as it will help you grow as a developer.

Installation

Fork this repo, then:

git clone <url-to-your-fork-of-helpafamily-here>
cd helpafamily/
cp .env.example .env

Then,

If you're familiar with Docker

docker-compose build (it builds the docker container - needed only the first time or whenever the container gets removed)

If you don't wish to use Docker

yarn install

Running the project locally

without Docker

Once you have finished the Installation process you can run the project with

yarn dev

with Docker

docker-compose up (it runs the app inside the container)

and opening http://127.0.0.1:3000

FAQ

I contributed. Can I use this project in my coding portfolio?

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