-
First off, thank you for considering contributing.
-
There are many ways to contribute, from improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into project itself.
-
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
-
Please make sure to add you issue number while submitting your pull request (PR).
-
You can also edit the readme and make it more user friendly to help out new contributors.
✅ Users can create personalized URLs
✅ Check user input to make sure it's URL
✅ Support for ftp[s]
✅ Ability to view stats for individual links by adding "/stats" to URL
-
User can create a account and then generate and manage all the links and their stats from there
-
Security against cyber attacks
(more will be added along the way)
-
Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.
-
Friendly tutorial: http://makeapullrequest.com/
-
Feel free to ask for help; everyone is a beginner at first 😸
-
The smaller the proposed change, the better. If you’d like to propose two unrelated changes, submit two pull requests.
-
The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
-
If this is your first pull request, it may help to understand GitHub Flow.
-
Including screenshots/video of final interface/changes in your pull request is a must.