# Contribution guidelines

Thanks for considering contributing to Darkwrite❤️ This document outlines how you can get started and how contributions are handled.
The following sections apply for both Darkwrite and the [darkwrite.app](https://darkwrite.app) website, and everything else hosted in this repository.

## Bugs
If something doesn't work or look right, you can create a bug report in the [issues tab.](https://github.com/astudentinearth/darkwrite/issues)

Check if an issue already exists regarding your problem. If it exists, you can subscribe to the issue thread to receive notifications, or participate in discussion in comments (don't hesitate to engage🙂). 

Otherwise you can create the issue yourself. When you click "New Issue", GitHub should offer a "Bug Report" template, you can use it to draft your report. You can skip the template altogether for quick questions if you wish :)

## Feature requests
Go to the [issues tab.](https://github.com/astudentinearth/darkwrite/issues) and check if someone already requested a similar feature. If a request is already open, you can subscribe to the thread for updates, or share your opinions on the requested feature. Discussion is essential to implement better features, and your thoughts are always welcome :)

On the same line with bugs, GitHub should offer a "Feature Request" template as well when creating one. You can use it to draft your request.

## Pull requests
You can contribute non-code patches with pull requests. **Code contributions won't be accepted until Darkwrite is out of beta, as significant portions of the code change frequently and this may easily lead to your contributions getting removed as part of a refactor.** I believe your time and effort is more valuable than this, so don't submit code patches yet❤️

Non-code patches you can submit include:
- translations
- user guide and developer documentation
  - Our user guide has been lacking since forever by the way, you can easily make your first contribution by submitting doc pages.🙂 Create an issue if you want to submit new documentation and I'll be here to help❤️
- if something's off with the readme or issue templates, you can propose changes as well

Your submissions will be recognized in the changelog, if you want you can add your changes to the top of [CHANGES.md](./CHANGES.md) as part of your submission yourself. (if you don't, I'll manually add it, so don't feel pressured).

If you submit translations, you'll be recognized in the README as well.

You need to agree to the [Developer Certificate of Origin](https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin) if you are creating pull requests. Your commits must include a `Signed-Off-by: <your name> <your email>` line at the end of the commit message body to signify your acceptance. Git can automatically add this line for you if you commit with `git commit -s`

> If you are making your first contribution, I highly recommend getting used to this flow, as most other open source projects also require you to sign off your commits. If you run into problems, don't hesitate to ask for help :)

```
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.
```