mirror of
https://github.com/soywod/himalaya.git
synced 2024-11-25 20:40:24 +00:00
43 lines
2 KiB
Markdown
43 lines
2 KiB
Markdown
|
# Himalaya contributing guide
|
||
|
|
|
||
|
|
Thank you for investing your time in contributing to Himalaya!
|
||
|
|
|
||
|
|
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
|
||
|
|
|
||
|
|
## New contributor guide
|
||
|
|
|
||
|
|
To get an overview of the project, read the [README](README.md). To get more information about the project, read the [wiki](https://github.com/soywod/himalaya/wiki).
|
||
|
|
|
||
|
|
## Getting started
|
||
|
|
|
||
|
|
### Issues
|
||
|
|
|
||
|
|
#### Create a new issue
|
||
|
|
|
||
|
|
If you spot a problem with the docs, [search if an issue already exists](https://github.com/soywod/himalaya/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/soywod/himalaya/issues/new/choose).
|
||
|
|
|
||
|
|
#### Solve an issue
|
||
|
|
|
||
|
|
Scan through our [existing issues](https://github.com/soywod/himalaya/issues) to find one that interests you. You can narrow down the search using `labels` as filters. If you find an issue to work on, you are welcome to open a PR with a fix.
|
||
|
|
|
||
|
|
### Make Changes
|
||
|
|
|
||
|
|
#### Make changes in the UI
|
||
|
|
|
||
|
|
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
|
||
|
|
|
||
|
|
#### Make changes locally
|
||
|
|
|
||
|
|
First, follow the instructions on [how to install Himalaya from sources](https://github.com/soywod/himalaya/wiki/Installation:sources). Then, create a working branch and start with your changes!
|
||
|
|
|
||
|
|
### Commit your update
|
||
|
|
|
||
|
|
Commit the changes once you are happy with them. Commit messages follow the [Angular Convention](https://gist.github.com/stephenparish/9941e89d80e2bc58a153), but contain only a subject. The subject can be prefixed with a custom context like `msg: `, `mbox: `, `imap: ` etc.
|
||
|
|
|
||
|
|
> Use imperative, present tense: “change” not “changed” nor
|
||
|
|
> “changes”<br>Don't capitalize first letter<br>No dot (.) at the end
|
||
|
|
|
||
|
|
### Pull Request
|
||
|
|
|
||
|
|
When you're finished with the changes, create a pull request, also known as a PR.
|