Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 5.65 KB

CONTRIBUTING.md

File metadata and controls

84 lines (50 loc) · 5.65 KB

Welcome to Apption contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will make apption even better ✨.

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 on the 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 file. Here are some resources to help you get started with open source contributions:

Getting started

You can contribute to Apption in many ways. Some of them don't even require writing a single line of code ✨. These are just some of the ideas that scream to mind, in no particular order:

  • Partake in project discussions. We want talk about this, both formally and casually, to increase awareness about all aspects of this project for all of us and to build community and support. You can start or join discussions here.

  • Find or fix issues. When projects gain traction, many issues get discovered as it gets utilized in previously unforeseen scenarios. These will need to be considered and hopefully resolved to ensure the project continues to meet the needs of those that rely on it in their work. You will find many opportunities to contribute here simply by using ActionObject or visiting the issues page.

Issues

Create a new issue

If you spot a problem with apption, 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 "Label reference" 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

Make changes to the project description

You can start your contribution journey with small changes such as a typo, sentence fix, or a broken link in the README, CONTRIBUTING or CODE_OF_CONDUCT files.

  1. Fork the repository.
  • Simply click the fork button at the top right corner of the project page.
  1. Make your changes.
  2. create a pull request for a review.

Make changes locally

  1. Fork the repository.

  1. Install or update Node.js.

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

Commit your update

Commit the changes once you are happy with them.

Pull Request

When you're finished with the changes, create a pull request.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • 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 team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged using 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.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 You have done valuable work for the web ✨.

Once your PR is merged, your contributions will be publicly visible on the main Apption project.