Merge pull request #109 from bluewave-labs/copy-settings-page

Settings Page

Author: olusegunawowole

.coderabbit.yaml

@@ -0,0 +1,13 @@
+language: "en-CA"
+early_access: false
+reviews:
+  profile: "assertive"
+  request_changes_workflow: false
+  high_level_summary: false
+  poem: false
+  review_status: true
+  auto_review:
+    enabled: true
+    drafts: false
+chat:
+  auto_reply: false

.gitignore

@@ -4,7 +4,6 @@
 /node_modules
 /.pnp
 .pnp.js
-/client
 
 # testing
 /coverage
@@ -19,6 +18,9 @@
 .env.development.local
 .env.test.local
 .env.production.local
+.env
+/dev
+/constants/data/images
 
 .storybook
 .vscode
@@ -27,3 +29,9 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+*storybook.log
+.storybook/
+/src/stories
+
+.env

CONTRIBUTING.md

@@ -0,0 +1,104 @@
+
+# Contributing to the BlueWave HRM application
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how the HRM project handles them. Please make sure to read the relevant section before making your contribution. It will make it much easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
+
+> And if you like the project, but don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+> - Star the project
+> - Tweet about it
+> - Refer this project in your project's readme
+> - Mention the project at local meetups and tell your friends/colleagues
+
+## Table of Contents
+
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+- [Suggesting Enhancements](#suggesting-enhancements)
+
+## I Have a Question
+
+If you'd like to ask a question, we assume that you have read the available readme.md files. In the near future we'll come up with a proper installation and usage document.
+
+Before you ask a question, search for existing [Issues](/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an [Issue](/issues/new).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (NodeJs, PostgreSQL, etc), depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+
+## I Want To Contribute
+
+> ### Legal Notice 
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+### Reporting Bugs
+
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions. If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](issues?q=label%3Abug).
+- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
+- Collect information about the bug:
+- Stack trace (Traceback)
+- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+- Version of the interpreter, compiler, SDK, runtime environment and package manager, depending on what seems relevant.
+- Possibly your input and the output
+- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [email protected]
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Explain the behaviour you would expect and the actual behaviour.
+- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports, you should isolate the problem and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
+
+## Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for the app, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community understand your enhancements and find related suggestions.
+
+- Make sure that you are using the latest version.
+- Find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to.
+- **Explain why this enhancement would be useful** to most CONTRIBUTING.md users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+We have a Figma file that includes: 
+
+- All the dashboard elements and components
+- The design guideline for the app
+
+You can see the dashboard designs [here](https://www.figma.com/design/GC5nLN8GAXV9NJkzEnDRj3/HRM-app?node-id=1-1207&t=wzDWuABPkPl5Tdeb-1), and the style guides [here](https://www.figma.com/design/USQRG7Oacv7uXw8XkTPINq/Style-guide?node-id=170-4048&t=QwZ5JRnYywYsScLj-1). Since they are read-only, we encourage you to copy to your own Figma page, then work on it.
+ 
+[This document](https://docs.google.com/document/d/1Gy3LiimGUNoSiWAMbwyK3SeMADcCMjCLu6cQYoawtSE/edit#heading=h.1lj2lgut6m7h) outlines the process every developer should follow for managing the issues lifecycle. Also make sure you read the [document about how to make a good pull request](/PULLREQUESTS.md).
+
+## Attribution
+This guide is based on the **contributing.md**. [Make your own](https://contributing.md/)!

Entity Relationship Diagram.png

@@ -0,0 +1,32 @@
+## The Importance of Small Pull Requests
+
+
+Pull requests are an integral part of our workflow, but does the scope of your pull request matter?  In my opinion yes it does, and here’s why I think so
+
+### Smaller PRs make you spend more time thinking about your code before you write it
+
+Spend some time thinking about the PR you are going to open.  If you think about the scope of the PR you will be forced to limit the scope of your feature, and that will force you to plan your code out.
+
+### Smaller PRs are easier to review
+
+If a PR is massive and complicated it is very difficult to review.  Reviewers are busy working on their own features and can quickly run into cognitive limits when a large PR comes in.  A PR should be simple enough that a busy dev can jump on the review without fatiguing themself.
+
+### Smaller PRs get better reviews
+
+The smaller your PR, the greater the amount of quality feedback a reviewer can give you.  If you have 600 lines of codes you are not going to get decent feedback at line 500.  Try to limit your PRs to 200 lines of code at the most in order to get quality feedback from your reviewers.
+
+### Smaller PRs get reviewed faster and merged faster
+
+If your PR is short and sweet your reviewers can get you feedback ASAP, this reduces the turnaround time for the whole pull request.  If it takes your reviewer a whole day to review your pull request you are looking at 2 days for the 
+
+	Pull Request -> Review -> Revise -> Review -> Merge
+
+Process.  If more revisions are required after the second review we’re looking at almost a week to get the feature reviewed, revised, and merged in.
+
+### Smaller PRs lead to better quality code
+
+If PRs are small and manageable it is far more likely that a dev will catch bugs during the review process.  If our eyes glaze over at line 400 of a 700 line PR since we’ve reached our cognitive limit we’re not going to likely miss bugs in the last 300 lines of code.
+
+### Bonus Topic:  Keep PRs focused
+
+It may be tempting to address a bug you suddenly remembered or make some tiny adjustments in some component that bothers you, but don’t!  Keep all commits in your pull request fully focused on the specific feature you are working on.  Open up another PR if you want to fix a big or work on another feature.

PULLREQUESTS.md

@@ -1,10 +1,19 @@
-# BlueWave HR
+![](https://img.shields.io/github/license/bluewave-labs/bluewave-hrm)
+![](https://img.shields.io/github/repo-size/bluewave-labs/bluewave-hrm)
+![](https://img.shields.io/github/commit-activity/w/bluewave-labs/bluewave-hrm)
+![](https://img.shields.io/github/last-commit/bluewave-labs/bluewave-hrm)
+![](https://img.shields.io/github/languages/top/bluewave-labs/bluewave-hrm)
+![](https://img.shields.io/github/issues-pr/bluewave-labs/bluewave-hrm)
+![](https://img.shields.io/github/issues/bluewave-labs/bluewave-hrm)
 
-The BlueWave HR is a people and resource management application for your organization. It has the following features: 
+
+# BlueWave HRM
+
+The BlueWave HRM is a people and resource management application for your organization. It has the following features: 
 
 - Team management
 - Employee management
-- Time off / vacation management
+- Time off & vacation management
 - Reporting
 
 ![Time off settings](https://github.com/bluewave-labs/hrm/blob/main/Time%20off.png?raw=true)

README.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+If you find a vulnerability, send it to [email protected] 
+
+Please do not create an issue for security vulnerabilities.