Skip to content

Adding contributing agreement #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kalaspuffar wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Adding contributing agreement #8

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd2cbaf
Adding contributing agreement
kalaspuffar Jul 31, 2019
a83f206
Improved wording.
kalaspuffar Aug 1, 2019
2afa233
Updated with suggestions from Joel.
kalaspuffar Aug 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to Dotify.

First of thank you for considering helping out with this project. All contributions are welcome. Here's what you can do to make the process as smooth and efficient as possible.

### I want to file a bug.

Then you open an issue under [issues](https://github.com/brailleapps/dotify.translator.impl/issues) and follow the
guide there. Please search before you post so we get as few duplicates as possible.

### I want to suggest a feature.

Then you open an issue under [issues](https://github.com/brailleapps/dotify.translator.impl/issues) and follow the
guide there. Please search before you post so we get as few duplicates as possible.

### I want to contribute code.

Before you begin if you are a new contributor it's helpful for you to visit our wiki at [wiki](https://github.com/brailleapps/wiki/wiki) there you can find extensive documentation and other helpful information that can help you make a contribution.

1. Create an issue describing the problem you're having or the feature you need. Try to be clear, concise and descriptive.
1. Unless the issue you're having is trivial, you should discuss with the team about possible solutions before you begin working on it. Discussions should be held on Github or replicated so other interested parties can contribute with their knowledge and follow progress.
1. Solve the problem. Unless there is a good reason not to, you should follow applicable guidelines and conventions, for example the [Principles](https://github.com/brailleapps/wiki/wiki/Principles).
1. Rebase your change so that it is ahead of the current master.
1. Make sure that your change works by running all applicable tests.
1. Make a PR and ask for a review.

That's it! If there are issues with your change, the team will contact you. If the current master has moved and it conflicts with your PR, you might be asked to rebase it again. You're responsible for resolving any conflicts with master until your PR has been merged.

### Code style

We are trying to keep an consistant coding convention in order to help readablility and make it easy to submit code.

More in-depth guidelines can be found at [Principles](https://github.com/brailleapps/wiki/wiki/Principles)