diff --git a/README.md b/README.md index 14d5308..7115443 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ # todo-list-app + +Collaborative project by @Michael-Liendo and @Daridjcm.Our project is based so that users can enter this website and use it as long as they can. + +> [!NOTE] +> If you clone this repository, including the .vscode folder, you must keep in mind that you have to have Git Bash enabled in the environment variables, that is, running on all terminals. + +## Features + +- Add new note (You can write shopping list, daily tasks, etc.). +- Delete existing note: At the moment you can delete a note. +- Date on which the note was created. +- You can write a title and description for a simple note. + +## Future features + +- You could delete all the notes that I create on a daily basis with a single click. +- When playing a note, above. It will redirect you to another page or modal to add more details such as (tags, photos and links). +- Depending on a predefined label (they come with a default color), an attempt will be made to match the note. +- Organize notes by tags and filter them. + +## To contribute to our project + +If you want to improve our project, please first read a series of instructions for a better technique or guide on how to upload it, write it and all that in. + +If you decide to contribute below, please read the [contribution guidelines](./public/docs/CONTRIBUTING.md) are detailed below. diff --git a/public/docs/CONTRIBUTING.md b/public/docs/CONTRIBUTING.md new file mode 100644 index 0000000..a19dcff --- /dev/null +++ b/public/docs/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing to todo-list-app + +We welcome contributions from the community to improve and enhance the **todo-list-app** project. If you're interested in contributing, please follow these guidelines: + +## Getting Started + +1. Fork the repository. + +2. Clone your forked repository to your local machine. + +3. Create a new branch for your contribution. + + ```bash + git checkout -b feature/your-contribution or username + ``` + +4. Make your changes and commit them. + + ```bash + git add . + git commit -m "Add your descriptive message" + ``` + +5. Push your changes to your fork. + + ```bash + git push origin feature/your-contribution + ``` + +6. Open a pull request (PR) with a clear title and description. + +## Code Style Guidelines + +Please adhere to the established code style guidelines: + +- Use consistent indentation (spaces or tabs). +- Be consistent and concise. +- Comment your code when necessary. + +## Bug Reports and Feature Requests + +If you encounter any bugs or have ideas for new features, please open an issue on our [issue tracker](https://github.com/Michael-Liendo/todo-list-app/issues). + +## License + +By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](./LICENSE) file in the root of the project. Thank you for contributing our project. diff --git a/public/docs/LICENSE b/public/docs/LICENSE new file mode 100644 index 0000000..f5da1eb --- /dev/null +++ b/public/docs/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Michael-Liendo and Dariana + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.