You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+
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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+
This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html
We welcome contributions to [Sourcerer App](https://github.com/sourcerer-io/sourcerer-app) by the community.
4
+
5
+
See [README](https://github.com/sourcerer-io/sourcerer-app) for more information about prerequirements and building project.
6
+
7
+
## How to report a problem
8
+
9
+
Please search before creating a new issue. Feel free to add issues related to the app or [sourcerer](https://sourcerer.io) site.
10
+
11
+
## Submitting сhanges
12
+
13
+
* Open a new issue in the [issue tracker](https://github.com/sourcerer-io/sourcerer-app/issues).
14
+
* Fork and clone the repo with `git clone https://github.com/your-username/sourcerer-app.git`.
15
+
* Create a new branch based off the `develop` branch.
16
+
* Make changes.
17
+
* Make sure all tests pass.
18
+
* Submit a pull request, referencing any issues it addresses.
19
+
20
+
We will review your Pull Request as soon as possible. Thank you for contributing!
21
+
22
+
## Integration testing
23
+
24
+
We will work on a special environment for contributors in the nearest future. For now one should use his personal or additional account on site.
25
+
26
+
## Style guides
27
+
### Commit messages
28
+
29
+
Format:
30
+
```type(component): message (jira issue tag, github issue number with #)```
31
+
32
+
Message types:
33
+
***feat** is used when new feature is provided;
34
+
***wip** is used when making regular commit and changes don't match any other types;
35
+
***fix** is used when you fix a bug;
36
+
***chore** is used when changes are about organization, not about logic;
37
+
***docs** is used when you add/change documentation.
38
+
Component is a decomposition unit your commit affected. Write message in present simple.
39
+
40
+
Examples:
41
+
feat(logger): add rotating
42
+
chore: remove redundant commas, add copyright
43
+
wip: pass models to routers
44
+
fix: program exit is prevented when button is pressed (COMP-1, #123)
45
+
46
+
### Kotlin style guide
47
+
* Code has a column limit of 80 characters.
48
+
* Inline comments should be indented with 2 spaces from code.
49
+
50
+
We are using [Kotlin Coding Conventions](https://kotlinlang.org/docs/reference/coding-conventions.html).
51
+
52
+
## Code of conduct
53
+
We value input from each member of the community, however we urge you to abide by [code of conduct](https://github.com/sourcerer-io/sourcerer-app/blob/master/CODE_OF_CONDUCT.md).
Copyright 2017 Sourcerer, Inc. https://sourcerer.io
2
+
3
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
+
5
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
+
7
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Copy file name to clipboardExpand all lines: README.md
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Prerequirements
17
17
18
18
* Sourcerer alpha/beta access
19
19
* Linux or macOS
20
-
* Java Platform ([JRE](http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html) for Linux or [JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) for macOS)
20
+
* Java 8+ Platform ([JRE](http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html) for Linux or [JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) for macOS)
21
21
* Git repositories with master branch with at least one commit
22
22
23
23
Install/uninstall
@@ -26,7 +26,7 @@ Install/uninstall
26
26
To install sourcerer run the following command:
27
27
28
28
```
29
-
curl -s https://sourcerer.io/install | bash
29
+
curl -s https://sourcerer.io/app/install | bash
30
30
```
31
31
32
32
To remove sourcerer from your machine:
@@ -53,3 +53,8 @@ $ gradle build -Penv=production
53
53
# Run the app
54
54
$ java -jar build/libs/sourcerer-app.jar
55
55
```
56
+
57
+
Contribution
58
+
============
59
+
60
+
We welcome contributions to Sourcerer App by the community. Check the [Contribution guide](https://github.com/sourcerer-io/sourcerer-app/blob/master/CONTRIBUTING.md)) for more information.
0 commit comments