Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
contributing
  • Loading branch information
evilthreads669966 authored Oct 6, 2020
1 parent 0ab3dbd commit 423235d
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,53 @@ Keylogger.subscribe { entry ->
//do something with keystrokes here
}
```
## Ask a Question?
- Use [Github issues](https://github.com/evilthreads669966/skimmer/issues)
- Send an email to [email protected]

## Reporting issues
Found a bug on a specific feature? Open an issue on [Github issues](https://github.com/evilthreads669966/skimmer/issues)

## Contributing

SMS Backdoor is released under the [Apache 2.0 license](https://github.com/evilthreads669966/skimmer/blob/master/LICENSE). If you would like to contribute
something, or simply want to hack then this document should help you get started.

### Code of Conduct
- Please refrain from using any profanity
- Please be respectful on [GitHub Issues](https://github.com/evilthreads669966/skimmer/issues)
- Have fun

### [Pull Requests](https://github.com/evilthreads669966/skimmer/pulls)
- Please create a branch prefixed with what you're working on.
- FEATURE_ADDING_SOMETHING
- BUG_FIXING_SOMETHING
- REFACTOR_CHANGING_SOMETHING
- Once you're done with your commits to this branch hit a [pull request](https://github.com/evilthreads669966/skimmer/pulls) off and I'll look at it and most likely accept it if it looks good.

### Using [GitHub Issues](https://github.com/evilthreads669966/skimmer/issues)
We use [GitHub issues](https://github.com/evilthreads669966/skimmer/issues) to track bugs and enhancements.
- If you find a bug please fill out an issue report. Provide as much information as possible.
- If you think of a great idea please fill out an issue as a proposal for your idea.

### Code Conventions
None of these is essential for a pull request, but they will all help. They can also be
added after the original pull request but before a merge.

- We use idiomatic kotlin conventions
- Add yourself as an `@author` to the `.kt` files that you modify or create.
- Add some comments
- A few unit tests would help a lot as well -- someone has to do it.
- If you are able to provide a unit test then do.
- Because of the types of libraries I develop often times it is hard to test.


### Working with the code
If you don't have an IDE preference we would recommend that you use
[Android Studio](https://developer.android.com/studio/)
## Contributors
This project exists thanks to all the people who contribute.
<a href="https://github.com/evilthreads669966/skimmer/graphs/contributors"><img src="https://opencollective.com/skimmer/contributors.svg?width=890&button=false" /></a>
## License
```
Copyright 2020 Chris Basinger
Expand Down

0 comments on commit 423235d

Please sign in to comment.