Skip to content

Commit 91c389f

Browse files
tinesofttinesoft
committed
chore(github): add github files and update contribution section
1 parent 82e5cf1 commit 91c389f

File tree

5 files changed

+228
-1
lines changed

5 files changed

+228
-1
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. 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.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at github@wassim.app. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
38+
39+
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.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

‎.github/CONTRIBUTING.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributing guidelines
2+
3+
tl;dr: Contributions to this repository follow the same general guidelines as the Angular organization.
4+
5+
As a contributor, here are the guidelines we would like you to follow:
6+
7+
* [Code of Conduct](#coc)
8+
* [Issues and Bugs](#issue)
9+
* [Feature Requests](#feature)
10+
* [Coding Rules](#rules)
11+
* [Git Workflow (AKA Branching/Merging Strategy)](#commit)
12+
* [Commit Message Guidelines](#commit)
13+
* [Signing the CLA](#cla)
14+
15+
## <a name="coc"></a> Code of Conduct
16+
17+
Please read and follow our [Code of Conduct][coc].
18+
19+
## <a name="issue"></a> Found a Bug?
20+
21+
If you find a bug in the source code, you can help us by
22+
[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can
23+
[submit a Pull Request](#submit-pr) with a fix.
24+
25+
## <a name="feature"></a> Missing a Feature?
26+
27+
You can _request_ a new feature by [submitting an issue](#submit-issue) to our GitHub
28+
Repository. If you would like to _implement_ a new feature, please submit an issue with
29+
a proposal for your work first, to be sure that we can use it.
30+
Please consider what kind of change it is:
31+
32+
* For a **Major Feature**, first open an issue and outline your proposal so that it can be
33+
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
34+
and help you to craft the change so that it is successfully accepted into the project.
35+
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
36+
37+
## <a name="gitflow"></a> Git Workflow (AKA branching/merging strategy)
38+
39+
To take full advantage of [semantic release](https://github.com/semantic-release/semantic-release), we use [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) as branching strategy. This means that PR must start from and be submitted to `develop` branch.
40+
41+
We do `git rebase` (instead of `git merge`) as merging strategy.
42+
43+
44+
## <a name="commit"></a> Commit Message Guidelines
45+
46+
We have very precise rules over how our git commit messages can be formatted. This leads to **more
47+
readable messages** that are easy to follow when looking through the **project history**. But also,
48+
we use the git commit messages to **generate the change log**.
49+
50+
### Commit Message Format
51+
52+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
53+
format that includes a **type**, a **scope** and a **subject**:
54+
55+
```
56+
<type>(<scope>): <subject>
57+
<BLANK LINE>
58+
<body>
59+
<BLANK LINE>
60+
<footer>
61+
```
62+
63+
The **header** is mandatory and the **scope** of the header is optional.
64+
65+
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
66+
to read on GitHub as well as in various git tools.
67+
68+
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
69+
70+
Samples: (even more [samples](https://github.com/manekinekko/angular-search-experience/commits/master))
71+
72+
```
73+
docs(changelog): update changelog to beta.5
74+
```
75+
76+
```
77+
fix(release): need to depend on latest rxjs and zone.js
78+
79+
The version in our package.json gets copied to the one we publish, and users need the latest of these.
80+
```
81+
82+
### Revert
83+
84+
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
85+
86+
### Type
87+
88+
Must be one of the following:
89+
90+
* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
91+
* **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
92+
* **docs**: Documentation only changes
93+
* **feat**: A new feature
94+
* **fix**: A bug fix
95+
* **perf**: A code change that improves performance
96+
* **refactor**: A code change that neither fixes a bug nor adds a feature
97+
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
98+
* **test**: Adding missing tests or correcting existing tests
99+
100+
### Scope
101+
102+
The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages.
103+
104+
### Subject
105+
106+
The subject contains a succinct description of the change:
107+
108+
* use the imperative, present tense: "change" not "changed" nor "changes"
109+
* don't capitalize the first letter
110+
* no dot (.) at the end
111+
112+
### Body
113+
114+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
115+
The body should include the motivation for the change and contrast this with previous behavior.
116+
117+
### Footer
118+
119+
The footer should contain any information about **Breaking Changes** and is also the place to
120+
reference GitHub issues that this commit **Closes**.
121+
122+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
123+
124+
A detailed explanation can be found in this [document][commit-message-format].
125+
126+
[coc]: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md
127+
[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#

‎.github/FUNDING.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# These are supported funding model platforms
2+
3+
github: tinesoft
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
custom: # Replace with a single custom sponsorship URL

‎.github/ISSUE_TEMPLATE.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!--
2+
IF YOU DON'T FILL OUT THE FOLLOWING INFORMATION YOUR ISSUE MIGHT BE CLOSED WITHOUT INVESTIGATING
3+
-->
4+
### Bug Report or Feature Request (mark with an `x`)
5+
```
6+
- [ ] bug report -> please search issues before submitting
7+
- [ ] feature request
8+
```
9+
10+
### Spring Versions?
11+
```
12+
- `spring boot version`:
13+
- or `spring`, 'spring-test`, and `spring-data-elasticsearch` versions:
14+
```
15+
16+
### OS Version?
17+
<!--
18+
> Windows 7, 8 or 10. Linux (which distribution).macOS(Yosemite ? El Capitan? Sierra ?)
19+
-->
20+
21+
### Elasticsearch server Version?
22+
<!--
23+
> Version of target Elasticsearch server
24+
-->
25+
26+
### Repro steps
27+
<!--
28+
Simple steps to reproduce this bug.
29+
Please include: commands run, packages added, related code changes.
30+
A link to a sample repo would help too.
31+
-->
32+
33+
34+
### The log given by the failure
35+
<!-- Normally this include a stack trace and some more information. -->
36+
37+
38+
### Desired functionality
39+
<!--
40+
What would like to see implemented?
41+
What is the usecase?
42+
-->
43+
44+
45+
### Mention any other details that might be useful
46+
<!-- Please include a link to the repo if this is related to an OSS project. -->

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ $ npx elasticdump --input=http://localhost:9200/my_index --output=my_index_data.
110110
## Contributing
111111

112112
Contributions are always welcome! Just fork the project, work on your feature/bug fix, and submit it.
113-
You can also contribute by creating issues.
113+
You can also contribute by creating issues. Please read the [contribution guidelines](.github/CONTRIBUTING.md) for more information.
114114

115115
## License
116116

0 commit comments

Comments
 (0)