Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 2.87 KB
Raw

loganmatic - Contribution Guide

The loganmatic is a mathematics library created for use in JS, TS, JAVA, PYTHON and C# languages. Purely mathematical library, developed for people who like mathematics and challenges.

Important rule:

All methods must be developed without using external libraries!!!

The main idea is to develop all methods without using any external libs. Some libs may be allowed temporarily for the code to work. LIB Prohibited without exception: Any math lib.

How to Contribute

  1. Fork the Repository

    • Fork the loganmatic repository to your GitHub account.

  2. Clone the Repository

    • Clone the forked repository to your local environment: 
      git clone https://github.com/gabriel-logan/Math_Lib.git

  3. Commit and Push

    • Commit your changes and push them to the forked repository: 
      git add .
git commit -m "Concise description of the changes"
git push origin my-feature

  4. Open a Pull Request (PR)

    • Go to the forked repository on GitHub and open a PR to the main branch of the project.

Contribution Guidelines

feat: Adds a new feature to the project. For example:

feat: Add controller for user management fix: Fixes an existing bug or issue. For example:

fix: Fix validation error in the controller refactor: Restructures existing code without changing its functionality. For example:

refactor: Rearrange methods in the controller for better readability docs: Updates the project's documentation. For example:

docs: Update documentation for the user controller style: Makes code style-related changes, such as formatting, indentation, etc. For example:

style: Format code in the controller according to project guidelines test: Adds or modifies tests in the project. For example:

test: Add tests for the user controller chore: Performs maintenance tasks or other activities not directly related to code. For example:

chore: Update project dependencies for compatibility with new versions perf: Makes performance improvements in the code. For example:

perf: Optimize data query in the controller revert: Reverts a previous change. For example:

revert: Revert changes in the controller due to implementation issues ci: Makes modifications related to continuous integration (CI) and deployment. For example:

ci: Configure CI pipeline to automatically test the controller

  • Follow the coding standards of the language you're contributing to (JavaScript, TypeScript, Java, etc.).
  • Keep the code clean and readable.
  • Add tests for new functionalities or bug fixes.
  • Properly document the changes made, including updates to README if necessary.
  • Be respectful to other contributors and maintain a collaborative environment.

License

By contributing to loganmatic, you agree that your contributions will be licensed under the MIT license. Make sure you're familiar with the terms of this license.