Developed by Brandon Jabout and Caroline Curtis
Something™ is a basic application that alters the way a user's name is presented. This application allows the user to enter their first name. Once the first name has been captured, it asks for the user to enter a letter that is in their name. Once they enter a letter that is in their name, the application will remove that letter from their name. The user will then be prompted to enter their last name where it will be displayed with their first name.
In order to use this software the following conditions will need to be met:
- Python version 3.3 or later will need to be downloaded and installed on the machine
- Run the application by adding the version-control-lab.ipynb into JupyterHub. You can then press the run button to run he code.
- Enter your first name by typing in to the terminal when prompted to.
- Enter the character you would like removed. Make sure it is an actual character in your name, otherwise you will be prompted to renter.
- Enter your last name when prompted in the terminal.
Please view LICENSE.md for information regarding the license of this software. This license was chosen due to its simplicity and allowance of others to use our code for a variety of projects, however it maintains a limitation of liability and does not offer a warranty. We want many to be able to use this code for whatever they deem it necessary as we believe in giving to the community, but we would also like to maintain legal protections over ourselves in regards to this code, warranties, and liabilities.
As this is an open source project, we ask for your commitment and expertise in contributing to this project if you desire to do so. We aim to make this as simple as possible so that all parties can assist us in the development of this project. Our budget does not allow for the addition of many high experienced developers. Given this, we want to say thank you to anyone who can and is willing to help with this project.
Please make sure to add any additions to this project by forking this project into your own directory. This is done simply by going to our repository and clicking the "fork" button located at the top of the page. Once the project is forked, feel free to make any changes you believe are necessary to this project. We ask that all changes that are made have documentation so that we are able to understand your thought process and consider them when adding to the development project.
Once you push your changes to your repository, our in-house team members will review your repositories periodically. Any features decided to be placed into the official application will be merged with the main repository. In return, your name will be added in the README as a contributor so that you can recieve the proper recognition you deserve.
We once again thank you to all that decide to contribute to this project!
Please view our CODE-OF-CONDUCT.md for information on our Code of Conduct. We chose to base our Code of Conduct off of Contributor Covenant as it is simple to read in everyday English and it focuses on the core aspects of what we beleive in: kindness, accepting responsibility, and enforcing responsibility. We want our community to be a loving and caring community that helps each other, and we believe our Code of Conduct demonstrates that agenda.