Skip to content
This repository has been archived by the owner on Jan 23, 2024. It is now read-only.

Latest commit

 

History

History
58 lines (29 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

58 lines (29 loc) · 2.99 KB
Raw

Contributing to se-cust-man

Welcome to the "se-cust-man" project! We appreciate your interest in contributing. Please take a moment to review this document before submitting any contributions.

Project Overview

"se-cust-man" is a student project focused on customer management. It aims to provide a user-friendly interface for creating, setting, and deleting customer records.

How to Contribute

We welcome contributions from the community and encourage you to help us improve "se-cust-man". To contribute, please follow these steps:

  1. Fork the repository to your GitHub account.

  2. Create a new branch in your forked repository for your changes. It's recommended to use a descriptive branch name related to the feature or bug fix you are working on.

  3. Make your changes and ensure that the code adheres to the project's coding style and guidelines.

  4. Write tests, if applicable, to cover the new functionality or changes you've made.

  5. Commit your changes with a clear and concise commit message explaining the purpose of the commit.

  6. Push the changes to your forked repository.

  7. Submit a pull request (PR) to the main repository's main branch. Please provide a detailed description of your changes in the PR, including the motivation behind the changes and any relevant information to help reviewers understand the impact of the changes.

  8. Participate in the code review process and address any feedback or comments provided by the maintainers.

  9. Once your PR is approved and all feedback is addressed, it will be merged into the main repository. Congratulations on your contribution!

Code Guidelines

To maintain consistency and readability in the codebase, we follow these guidelines:

  • Use meaningful and descriptive variable, function, and class names.

  • Write clear and concise comments to explain complex or non-obvious sections of code.

  • Follow Scala's official style guide for code formatting and indentation.

  • Ensure that your code is free from compiler warnings and errors.

  • Write unit tests for your code to ensure its correctness and prevent regressions.

Issue Tracker

If you encounter any issues, have suggestions, or want to report a bug, please use the project's issue tracker on GitHub. Provide as much detail as possible about the problem or suggestion, including steps to reproduce, expected behavior, and any relevant error messages or stack traces.

Project Timeline

Please note that until 01.08.2023, no external contributions will be accepted for the "se-cust-man" project. This restriction is in place to allow the student team to complete their work as part of their educational curriculum. However, you are still welcome to use the project, report issues, and provide feedback.

License

By contributing to the "se-cust-man" project, you agree that your contributions will be licensed under the project's existing license, unless otherwise specified.

Thank you for considering contributing to "se-cust-man"! We appreciate your support and look forward to your contributions.