-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Contributing · `ssuggestor` | ||
|
||
First off, thank you for considering contributing to this project. | ||
|
||
This tool start for solving an obstacle inside a bigger project. | ||
And it is meant to help others in the building app process. | ||
|
||
## 1. Set up your environment | ||
|
||
Read our documentation on the [readme](README.md). | ||
|
||
## 2. Create a Pull Request | ||
|
||
If you like to contribute, submit a new *PR*. | ||
I'll get back to you as soon as possible. | ||
|
||
### New features | ||
|
||
* remove bootstrap dependency | ||
* add style theme | ||
|
||
You can also see the pull request template [here](docs/pull_request_template.md). | ||
|
||
## 3. Report a Bug | ||
|
||
Let me know if you found a bug, have some new ideas to include, etc. | ||
|
||
See the issue template [here](docs/issue_template.md). | ||
|
||
## Me | ||
|
||
The maintenance of this project is carried on my freetime. | ||
|
||
If you liked the project, don't forget to star it! | ||
Any help from community is appreciated. | ||
|
||
Thanks! |