Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (34 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 2.64 KB

Contributing to the Attendance System API

We extend a warm welcome to those interested in contributing to our Attendance System API project. This project is an Attendance System API, meticulously crafted using Spring Boot, WebSocket, and JWT Authentication technologies, offering a robust and efficient solution for tracking and managing attendance records. To ensure a seamless and structured contribution process, we have outlined a set of comprehensive guidelines for your reference. Getting Started

Prior to embarking on your contribution journey, kindly ensure that you have the following prerequisites installed on your machine:

  • Java Development Kit (JDK) 21 or a later version
  • Gradle

Initiate the process by forking the repository on GitHub and subsequently cloning your fork to your local machine using the command:

git clone https://github.com/llTheBlankll/attendance-system-api-springboot.git

Navigate to the project directory to proceed:

cd attendance-system-api-springboot

Making Changes

For a more organized contribution process, we kindly request that you create a new branch specifically dedicated to your changes:

git checkout -b your-branch-name

Introduce your modifications and commits on this branch, ensuring that each commit is accompanied by a clear and descriptive message. Submitting Changes

Once you have completed your changes and are satisfied with the results, proceed to push your branch to your fork:

git push origin your-branch-name

Create a pull request on our repository, providing a concise yet informative description of the changes you have implemented. Our team will diligently review your pull request and offer constructive feedback or suggestions.

Contribution Guidelines

To maintain the highest standards of quality and consistency in contributions:

  • Adhere diligently to the established coding style and conventions prevalent in the project.
  • Accompany your code with unit tests to ensure comprehensive test coverage and enhance stability.
  • Provide clear and exhaustive documentation for any new features or modifications introduced to the API.
  • Focus each pull request on a single feature or bug fix to facilitate a streamlined review process.
  • Maintain a responsive attitude towards feedback and be open to incorporating suggested changes.

We extend our sincere gratitude for your interest in contributing to the Attendance System API project. Your contributions are highly valued, and we eagerly anticipate reviewing them. Should you have any queries or require further guidance, please do not hesitate to contact the project maintainers.