andreen-muchiri / hrm

Design guidelines

The following are the guidelines to be followed when using measurements in styling components and HTML elements:

• The root width of the component should use the VW measurement and child elements should use the percentage
• The root height of the component should use VH measurement and child elements should use percentage
• The font size of:
  • Paragraphs - use 1rem
  • Sub-headings 1.3rem
  • Headings 1.6rem

Consider using flex for display before using Grid or any other alternative.

Contribution guidelines

Thank you for considering contributing to our React project! This document outlines the guidelines for contributing to our project and the types of contributions that we welcome.

Purpose of the project

Our project aims to create a minimum viable product (MVP) for HRTECH international. We welcome contributions that help us achieve this goal.

Types of contributions

We welcome the following types of contributions:

• Bug fixes
• Feature requests
• Documentation improvements
• Code optimizations
• Testing improvements
• Other improvements that align with the purpose of the project

Getting started

To get started with contributing to our project, follow these steps:

1. Clone the project repository.
2. Run npm install to install the project dependencies.
3. Set up your development environment by following the instructions in the README file.
4. Check the issue tracker to find an issue that you would like to work on, or create a new issue if you have identified a bug or a feature request.
5. Discuss your ideas and proposed changes with the project maintainers.
6. Work on the issue or make the necessary changes to the codebase.
7. Write clear, concise commit messages and include documentation and tests for your changes.
8. Run tests to ensure that your changes do not break existing functionality.
9. Push your changes to your forked repository.
10. Submit a pull request to the main repository.
11. Respond to feedback from the project maintainers and make any necessary changes to your code.
12. Follow best practices for code style and formatting.

Issue tracker

The issue tracker is the best place to report bugs, feature requests, or other issues. Please follow these guidelines when reporting an issue:

• Clearly describe the issue or feature request.
• Provide steps to reproduce the issue, if applicable.
• Provide any relevant logs or error messages.
• Assign the appropriate label to the issue, such as a bug or enhancement.

Pull requests

When submitting a pull request, please follow these guidelines:

• Clearly describe the changes you have made and why they are necessary.
• Include a reference to the issue that your pull request addresses.
• Include documentation and tests for your changes.
• Write clear, concise commit messages.
• Respond to feedback from the project maintainers in a timely and professional manner.

Updating your forked repository

To keep your forked repository up-to-date with the main repository, follow these steps:

1. Fetch the latest changes from the main repository.
2. Merge the changes into your local branch.
3. Push the changes to your forked repository.

Thank you for contributing to our project!