Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

60 lines (39 loc) · 2.56 KB

Contributing to autofirma-nix

First off, thank you for considering contributing to autofirma-nix. It's people like you that make this project great!

The following is a set of guidelines for contributing to autofirma-nix, which is hosted in the nix-community on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue in the issue tracker. Please include as much detail as possible, including steps to reproduce the issue, your environment, and any relevant logs.

Suggesting Enhancements

If you have an idea for an enhancement or a new feature, please open an issue in the issue tracker and describe your idea in detail. We welcome all suggestions and will discuss them to see if they align with the project's goals.

Pull Requests

Getting Started

  1. Fork the repository.
  2. Clone your fork to your local machine.
  3. Create a new branch for your changes.

Making Changes

  1. Make your changes in your local branch.
  2. Write clear and concise commit messages. Follow the Conventional Commits specification.
  3. Ensure that your code adheres to the project's coding standards.
  4. If you've added code that should be tested, add tests.
  5. Run the test suite to ensure that all tests pass.

Submitting Pull Requests

  1. Push your changes to your fork.
  2. Open a pull request against the main branch in the upstream repository.
  3. In the pull request description, explain the purpose of your changes and link to any relevant issues.
  4. Be prepared to discuss and iterate on your changes. We may ask you to make modifications, and that's okay!

Coding Standards

  • Follow the existing coding style in the repository.
  • Write clear and concise code.
  • Document your code where necessary.
  • Ensure that your code is well-tested.

Testing

  • Add tests for any new functionality you introduce.
  • Ensure that all existing tests pass before submitting your pull request.
  • Run nix flake check to run the test suite.

Additional Resources

Thank you for your contributions!