Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.94 KB
Raw

How to contribute

First off, thanks for taking the time to contribute, it is encouraging! 🎉🙌

We want to make it as easy as possible to contribute changes that help the .allstar allstar configuration repo, this is a configuration repo for the good of the kommitters organization so every advice or contribution is well received. There are a few guidelines that we ask contributors to follow so that we can merge your changes quickly.

Getting started

  • Make sure you have a GitHub account.
  • Create a GitHub issue for your contribution, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce if it is a bug.
  • Fork the repository on GitHub.
  • Try to keep your local repository in a "rebased" state.

Making changes

  • Create a topic branch from where you want to base your work.
    • This is usually the main branch.
    • Please avoid working directly on the main branch.

Submitting changes

  • All content, comments, pull requests and other contributions must comply with the Code of Conduct.
  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request.
    • Include a descriptive commit message.
    • Changes contributed via pull request should focus on a single issue at a time.
    • Rebase your local changes against the main branch. Resolve any conflicts that arise.

At this point, you're waiting on us. We like to at least comment on pull requests within three business days (typically, one business day). We may suggest some changes, improvements or alternatives.

Additional resources