Skip to content

Commit 399680c

Browse files
committed
standard readme
1 parent 86c2283 commit 399680c

File tree

3 files changed

+133
-0
lines changed

3 files changed

+133
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,6 @@ data
111111

112112
# idea
113113
.idea
114+
115+
# selenium
116+
debug.log

CONTRIBUTING.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Contributing
2+
3+
**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
4+
5+
When contributing to this repository, please first discuss the change you wish to make via issue,
6+
email, or any other method with the owners of this repository before making a change.
7+
8+
Please note we have a code of conduct, please follow it in all your interactions with the project.
9+
10+
## Pull Request Process
11+
12+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
13+
build.
14+
2. Update the README.md with details of changes to the interface, this includes new environment
15+
variables, exposed ports, useful file locations and container parameters.
16+
3. Increase the version numbers in any examples files and the README.md to the new version that this
17+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
18+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
19+
do not have permission to do that, you may request the second reviewer to merge it for you.
20+
21+
## Code of Conduct
22+
23+
### Our Pledge
24+
25+
In the interest of fostering an open and welcoming environment, we as
26+
contributors and maintainers pledge to making participation in our project and
27+
our community a harassment-free experience for everyone, regardless of age, body
28+
size, disability, ethnicity, gender identity and expression, level of experience,
29+
nationality, personal appearance, race, religion, or sexual identity and
30+
orientation.
31+
32+
### Our Standards
33+
34+
Examples of behavior that contributes to creating a positive environment
35+
include:
36+
37+
* Using welcoming and inclusive language
38+
* Being respectful of differing viewpoints and experiences
39+
* Gracefully accepting constructive criticism
40+
* Focusing on what is best for the community
41+
* Showing empathy towards other community members
42+
43+
Examples of unacceptable behavior by participants include:
44+
45+
* The use of sexualized language or imagery and unwelcome sexual attention or
46+
advances
47+
* Trolling, insulting/derogatory comments, and personal or political attacks
48+
* Public or private harassment
49+
* Publishing others' private information, such as a physical or electronic
50+
address, without explicit permission
51+
* Other conduct which could reasonably be considered inappropriate in a
52+
professional setting
53+
54+
### Our Responsibilities
55+
56+
Project maintainers are responsible for clarifying the standards of acceptable
57+
behavior and are expected to take appropriate and fair corrective action in
58+
response to any instances of unacceptable behavior.
59+
60+
Project maintainers have the right and responsibility to remove, edit, or
61+
reject comments, commits, code, wiki edits, issues, and other contributions
62+
that are not aligned to this Code of Conduct, or to ban temporarily or
63+
permanently any contributor for other behaviors that they deem inappropriate,
64+
threatening, offensive, or harmful.
65+
66+
### Scope
67+
68+
This Code of Conduct applies both within project spaces and in public spaces
69+
when an individual is representing the project or its community. Examples of
70+
representing a project or community include using an official project e-mail
71+
address, posting via an official social media account, or acting as an appointed
72+
representative at an online or offline event. Representation of a project may be
73+
further defined and clarified by project maintainers.
74+
75+
### Enforcement
76+
77+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
78+
reported by contacting the project team at meitantei-conan@live.jp . All
79+
complaints will be reviewed and investigated and will result in a response that
80+
is deemed necessary and appropriate to the circumstances. The project team is
81+
obligated to maintain confidentiality with regard to the reporter of an incident.
82+
Further details of specific enforcement policies may be posted separately.
83+
84+
Project maintainers who do not follow or enforce the Code of Conduct in good
85+
faith may face temporary or permanent repercussions as determined by other
86+
members of the project's leadership.
87+
88+
### Attribution
89+
90+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
91+
available at [http://contributor-covenant.org/version/1/4][version]
92+
93+
[homepage]: http://contributor-covenant.org
94+
[version]: http://contributor-covenant.org/version/1/4/
95+
96+
### Thanks!
97+
98+
This contributing manifest is [PurpleBooth's Gist] .
99+
Special Thanks!
100+
101+
[PurpleBooth's Gist]: https://gist.github.com/PurpleBooth/b24679402957c63ec426

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,32 @@
66
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
77
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
88

9+
> Crawl Ask.fm QA lists and create corpus for ML.
10+
11+
This is a selenium tasks to crawl Ask.fm because of correcting QA list for Machine Learning.
12+
13+
## Table of Contents
14+
15+
- [Background](#background)
16+
- [Install](#install)
17+
- [Usage](#usage)
18+
- [Contributing](#contributing)
19+
- [License](#license)
20+
21+
## Background
22+
23+
## Install
24+
25+
## Usage
26+
27+
## Contributing
28+
29+
See [the contributing file](CONTRIBUTING.md)!
30+
31+
PRs accepted.
32+
33+
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
34+
35+
## License
36+
37+
[MIT © tubone.](LICENSE)

0 commit comments

Comments
 (0)