Skip to content

Commit

Permalink
Added markdown files for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
omriallouche committed May 29, 2019
1 parent d2de6ef commit 5bff977
Show file tree
Hide file tree
Showing 4 changed files with 188 additions and 0 deletions.
79 changes: 79 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
**We follow the Contributor Covenant Code of Conduct, used in over 40,000 open source projects, including Kubernetes, Rails, and Swift. It is pasted below for your convenience.**


# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Contribution

First off, thank you for considering contributing to Gecko. It’s people like you that make open source thrive, and make Gecko a great tool.

Gecko is under continuous development. If you have requests for features, please file an issue describing your request. Also, if you want to see work towards a specific feature, feel free to contribute by working towards it. The standard procedure is to fork the repository, add a feature, fix a bug, then file a pull request that your changes are to be merged into the main repository and included in the next release.

Here are some tips that might help - [How to contribute to the project](https://github.com/gong-io/gecko/HOW_TO_CONTRIBUTE.md)
86 changes: 86 additions & 0 deletions HOW_TO_CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Contribution Workflow

In order to follow a good GitHub collaboration workflow, there are some tips might be helpful.

## Build a development environment

Please read this issue [#149](https://github.com/chakki-works/doccano/issues/149) first.

## Update to latest version

Run the following command to get the latest version.

```
# Add upstream
git remote add upstream https://github.com/gong-io/gecko
# Fetch all the branches of that remote into remote-tracking branches,
git fetch upstream
# Make sure that you're on your master branch:
git checkout master
# Rewrite your master branch so that any commits of yours that
# aren't already in upstream/master are replayed on top of that
# other branch:
git rebase upstream/master
```

If you already wrote code directly on the master branch. This will cause conflict when you want to rebase latest version to your forked repo.

In order to rebase your forked repo (master branch) to the latest version. You should make a copy of your code, where the code you already wrote. And then run the following command.

```
# Add upstream
git remote add upstream https://github.com/gong-io/gecko
# Fetch all the branches of that remote into remote-tracking branches,
git fetch upstream
# Make sure that you're on your master branch:
git checkout master
# Rewrite your master branch to make your local doccano be the same with upstream/master
git reset --hard upstream/master
# Make your forked repo same as the upstream
git push -f origin master
```

`git reset --hard upstream/master` will make your local version totally match the project's master branch and delete the work you have committed. So, please make a copy before running the `git reset --hard upstream/master`.

`git push -f origin master` will make your forked repo be same with the master branch.

## Development

Right now, your local master branch, origin master branch (forked repo in GitHub), and upstream master branch (original doccano repo) should be the same.

Usually, we use a new branch for feature development or bug fix, like 'feature/auto_label', 'bug/annotation. For example, we want to implement the JSON export feature, so we name a new branch as `feature/json_export`.

```
git checkout -b 'feature/json_export'
```

You should make all your commit in this branch. Remember I told you to make a copy? Here you can use the copied code in the development.

As for the commit message, it would be great to add an issue prefix. For example, `git commit -m 'iss17: support for exporting JSON file'`. This is for an explicit statement.

## Pull Request (PR)

After you finish the development, you can make a PR.

First, push the branch to origin

```
git push origin feature/json_export
```

Then make a PR in the GitHub page you forked. Below is not command, just for demo.

```
BrambleXu wants to merge 5 commits into gong-io:master from BrambleXu:feature/json_export
```

You can write some descriptions in the comment for this PR. This [Git Commit Message Style Guide](http://udacity.github.io/git-styleguide/?utm_source=wanqu.co&utm_campaign=Wanqu+Daily&utm_medium=website) might be helpful.

If you have any questions feel free to ask us.
16 changes: 16 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
If you open a GitHub issue, here is our policy:

1. It must be a bug, a feature request, or a significant problem with documentation (for small docs fixes please send a PR instead).
2. The form below must be filled out.

------------------------

### System information
- **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**:
- **Python version**:

### Describe the problem
Describe the problem clearly here. Be sure to convey here why it's a bug or a feature request.

### Source code / logs
Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached. Try to provide a reproducible test case that is the bare minimum necessary to generate the problem.

0 comments on commit 5bff977

Please sign in to comment.