Skip to content

Latest commit

History

History
85 lines (58 loc) 路 2.39 KB

CONTRIBUTING.md

File metadata and controls

85 lines (58 loc) 路 2.39 KB

dotfiles logo

Dotfiles (v0.2.468)

Simply designed to fit your shell life 馃悮

Dotfiles banner

Contributing to Dotfiles

Thank you so much for wanting to contribute to Dotfiles! There are a couple ways to help out.

Evangelize

Just tell people about Dotfiles. We believe that a bigger, more involved community makes for a better product, and that better products make the world a better place. We can always use more feedback and learn from you.

How to Contribute

Please find down here, our guides for submitting issues and pull requests.

Bug Reports

If you encounter a bug that hasn't already been filled, please file a bug report. Let us know of things we should fix, things we should add, questions, etc.

Warning us of a bug is possibly the single most valuable contribution you can make to Dotfiles.

  • Head here to submit a new issue.
  • Include a descriptive title that is straight to the point.
  • Write a detailed description on what the issue is all about.
  • Wait for someone to get to the issue and add labels.
  • The issue will be fixed soon!

Code Contributions

Contributing code is one of the more difficult ways to contribute to Dotfiles.

Feature Requests

Filling feature requests is one of the most popular ways to contribute to Dotfiles.

Is there some feature request that you'd like to code up yourself? Is there a feature you asked for yourself that you'd like to code?

Here's how to contribute code for a new feature to Dotfiles. Pull requests allow you to share your own code with us, and we can merge it into the main repo.

Adding Code

  • Fork the repo.
  • Clone the repo you forked by running git clone https://github.com/sebastienrousseau/dotfiles.git

Fixing an Issue

Have you found a solution to an issue? Here is how you can submit your code to Dotfiles.

  • Fork the repo, and refer above for how to change up code.
  • Head to your local fork of the repo, and click the "New Pull Request" button.
  • Include a title that is straight to the point.
  • Wait for someone to review the pull request, and then merge your pull request!