-
-
Notifications
You must be signed in to change notification settings - Fork 26
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
30 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 |
---|---|---|
@@ -1 +1,31 @@ | ||
# Contributing | ||
|
||
First of all, thank you for deciding to contribute to the project. There are several ways to help the project develop. | ||
|
||
## Share your config | ||
|
||
Many users, who are just starting to create their homepages, face confusion on how to set it all up. | ||
We have created a special section [user examples](showcase.md), where we suggest you to add your config [by creating an issue](https://github.com/hywax/mafl/issues/new?assignees=&labels=showcase&projects=&template=showcase.yml&title=%5BSHOWCASE%5D+%3Ctitle%3E). | ||
|
||
## Add your translation | ||
|
||
If you know a language that is not in `Mafl`, you can make a very valuable contribution by adding a new translation. | ||
Thus a large number of people can use `Mafl`. After all, not everyone knows English. | ||
|
||
## Add a new service | ||
|
||
Use the instructions for adding a new service in the [development](development.md) section. If you know javascript | ||
adding a new service will take no more than 1 hour. | ||
|
||
But if you don't know how to program, but you really want your idea to be realized - [create an issue](https://github.com/hywax/mafl/issues/new?assignees=&labels=feature+request&projects=&template=feature-request.yml&title=%5BFEATURE_REQUEST%5D+%3Ctitle%3E). | ||
|
||
## Bug fix | ||
|
||
At the time of use, it is possible that flaws in the application will pop up. This is normal. There are no applications where everything is perfect. | ||
If you know the javascript programming language, you can try to fix the issue yourself. Or [create an issue](https://github.com/hywax/mafl/issues/new?assignees=hywax&labels=bug&projects=&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E) | ||
and I will try to help you! | ||
|
||
## Star on Github | ||
|
||
And of course the easiest thing you can do is just give us a star on [Github](https://github.com/hywax/mafl). | ||
It's a couple of seconds for you, but it would be my pleasure! |