Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

86 lines (59 loc) · 3.59 KB
Raw

Contributing to OpenWeightlifting

Thank you for considering contributing to OpenWeightlifting!

Table of Contents

Code of Conduct

Before you start contributing, please read and adhere to our Code of Conduct. We expect all contributors to follow these guidelines to maintain a respectful and welcoming community.

Getting Started

  1. Rmember to read code of conduct.
  2. [Discord]("TODO: add a link to discord") to be used for discussions.

For PR

  1. Fork the repository to your own GitHub account.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your work with a proper well defined name (see Branches naming convention).
  4. Make your changes and commit them with meaningful commit messages.
  5. Open PRs to development branch (Remember to Squash before making a pr).
  6. If the PR is in relation to an issue/feature then it must be referenced within the PR.
  7. TODO comments are fine but an issue must recorded when doing so.
  8. Tests are not strictly required but nice to have.

Branches naming convention:

  • feature/ for new feature implementations
  • fix/ for broken code, build and/or bug fixes
  • chore/ for non-breaking & non-fixing code changes such as linting, formatting, etc.

For Issue

  1. Issues can be raised but templates must be followed.

Contributing Guidelines

Code Style

  • Follow consistent code style throughout the project.
  • Use indentation with 4 spaces.
  • Use clear and descriptive variable and function names.
  • Comment your code where necessary to explain complex logic.

Variable Names

  • Use meaningful and descriptive variable names.
  • Avoid single-letter variable names unless they are for loop counters.

Documentation

  • Ensure that your code is well-documented.
  • Include comments to explain the purpose and usage of functions and classes.
  • Update the README.md file if your changes introduce new features or modify existing ones.

Testing

  • Tests are not strictly required but nice to have.

Submitting a Pull Request

  1. Push your changes to your forked repository.
  2. Create a pull request from your forked repository to the development branch of this repository on GitHub.
  3. Ensure that your pull request includes a clear description of the changes made and their purpose.
  4. Our team will review your pull request and provide feedback or merge it if everything looks good.

Spam and Invalid Contributions

Spammy or invalid contributions will not be tolerated. We take the quality of our project seriously. If your contributions are identified as spam or invalid, they will be marked accordingly. Please ensure that your contributions align with our guidelines and benefit the project.

Contact

If you have any questions or need further assistance, feel free to reach out to us on our [Discord] ("TODO: add a link to discord") to be used for discussions.