Skip to content

Soumyajit2825/TO-DO-LIST

Repository files navigation

TO-DO-LIST

Open Source Love svg1 PRs Welcome GitHub Repo stars GitHub contributors GitHub last commit GitHub repo size GitHub forks Github GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests

Star History Chart

A simple to-do-list webpage

BRIEF DESCRIPTION ABOUT THE PROJECT

This project is tailored towards those getting started in web development. The tech stack used is rudimentary, consisting of HTML, CSS and JavaScript.

DESCRIPTION OF EACH OF THE COMPONENT FILES

The bare bones of the website is given in the index.html and the styling is done by both the use of inline CSS and external CSS file.

The workings of the website is contained in the light-dark-mode.js and to-do.ja files.

As the names suggests, the light-dark-mode.js files shifts between light and dark modes.

![light mode][light-mode.png] ![dark mode][dark-mode.png]

working of to_do.js file

The purpose of the this file is to facilitate the addition, deletion and editing of tasks. This is done using the CRUD operational paradigm i.e. Create, Read, Update, Delete operations.

How to Contribute

  • Take a look at the Existing [Issues] or create your own!
  • Fork the Repo and create a Branch for any Issue that you are working upon.
  • Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
  • Add Screenshots to help us know what this is all about.

How to make a Pull Request

1. Fork the repository by clicking on the Fork symbol at the top right corner.

2. Clone the forked repository.

   git clone https://github.com/YOUR_USERNAME/TO-DO-LIST.git

3. Navigate to the project directory.

   cd TO-DO-LIST

4. Create a new branch:

   git checkout -b YourBranchName

5. Make changes in source code.

6. Add your details to contributors.json file in the below format:

{
    "github-username": "YOUR-GITHUB-USERNAME",
    "favourite-emoji": "YOUR-FAVOURITE-EMOJI",
    "favourite-color": "YOUR-FAVOURITE-COLOR"
}

7. Stage your changes and commit

   git add .
   git commit -m "<your_commit_message>"

8. Push your local commits to the remote repo.

   git push origin YourBranchName

9. Create a PR

Note If anyone contributes to this repository, then the changes will not be reflected in your local repository. For that:

10. Setup a reference(remote) to the original repository to get all the changes from the remote.

   git remote add upstream https://github.com/Soumyajit2825/TO-DO-LIST.git

11. Check the remotes for this repository.

   git remote -v

12. Fetching from the remote repository will bring in its branches and their respective commits.

   git fetch upstream

13. Make sure that you're on your master branch.

   git checkout master

14. Now that we have fetched the upstream repository, we want to merge its changes into our local branch. This will bring that branch into sync with the upstream, without losing our local changes.

   git merge upstream/master

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide. Any linting errors should be shown when running npm test.
  • Write and update tests.
  • Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocking you from working further.

Contributors ✨

Thanks goes to these wonderful people 💜

Resources

Please make sure to update tests as appropriate.

License

MIT