Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (38 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 1.89 KB

Contributing to LiftLog

Thank you for your interest in contributing to LiftLog! We welcome all contributions, whether you're fixing bugs, adding features, improving documentation, or suggesting ideas.

Code Style & Guidelines

  • Use Prettier and ESLint for formatting and linting TypeScript.
  • For C# code, use CSharpier for automatic code formatting. Run dotnet csharpier . in backend folders before committing.
  • Write clear, descriptive commit messages.
  • Follow the existing code structure and naming conventions.
  • Add comments where necessary, especially for complex logic.

Making Changes

  1. Create a new branch for your work: 
    git checkout -b feature/your-feature-name
  2. Make your changes and ensure all tests pass.
  3. Run tests:
    • Frontend: 
      npm test
    • Backend: 
      dotnet test
  4. Push your branch and open a Pull Request (PR) against main.

Pull Request Checklist

  • The code compiles and passes all tests.
  • Linting and formatting checks pass.
  • The PR description clearly explains the changes.
  • Related documentation is updated.
  • No sensitive information is included.

Reporting Issues

If you find a bug, please open an issue and provide as much detail as possible. If you have a feature request, please search through discussions to see if it has been suggested, and if not submit a new discussion. Feature requests will go through a vetting/planning phase in discussions before being turned into issues to signal it is planned or ready to be picked up.

License

By contributing, you agree that your contributions will be licensed under the AGPL v3 license.

Thank you for helping make LiftLog better!