Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) · 3.59 KB
Raw

Welcome to the contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on assistukrainians.com ✨.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Use the table of contents icon 📜 on the top left corner of this document to get to a specific section of this guide quickly.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Issues

Create a new issue

If you spot a problem with the site or something that could be improved, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

  1. Follow the How to run section of the README. Optionally you can fork the repository to make sure your changes don't affect the original project until you're ready to merge them.

  2. Create a working branch and start with your changes!

  3. Commit the changes once you are happy with them

  4. When you're finished with the changes, create a pull request, also known as a PR.

Pull requests

  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a maintainer will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.

Your PR is merged!

Congratulations 🎉🎉 The team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the assistukrainians.com.