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

Latest commit

 

History

History
46 lines (34 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

46 lines (34 loc) · 1.4 KB

Contributing

Thank you for considering contributing to Just an Allocator™! Here are some guidelines to help you get started.

Getting Started

  1. Fork the repository: Click the "Fork" button at the top right of the repository page.
  2. Clone your fork:
    git clone https://github.com/your-username/just-an-allocator.git
    cd just-an-allocator
  3. Create a branch:
    git checkout -b feature/your-feature-name

Making Changes

  1. Code Style: Follow the existing code style. Use consistent indentation and spacing.
  2. Write Tests: Ensure that your changes are covered by tests. Add new tests if necessary.
  3. Commit Changes:
    git add .
    git commit -m "Add a meaningful commit message"
  4. Push to your fork:
    git push origin feature/your-feature-name

Submitting a Pull Request

  1. Open a Pull Request: Go to the original repository and click the "New pull request" button.
  2. Describe your changes: Provide a clear description of what you have done and why.
  3. Link to issues: If your changes address an issue, link to it in the pull request description.

Code of Conduct

Please adhere to the Code of Conduct in all interactions.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions!