Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

66 lines (40 loc) · 2.87 KB
Raw

Contributing to AutoLLaMo

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to AutoLLaMo, an open source project on GitHub. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the AutoLLaMo Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

Suggesting Enhancements

If you have a suggestion that is not a bug and may make AutoLLaMo better, you can use the community discussion tools to suggest and discuss your ideas or directly create a pull request with your improvement.

Your First Code Contribution

Start by forking the repository and following the installation steps in the README.md.

Pull Requests

The process described here has several goals:

  • Maintain AutoLLaMo's quality
  • Fix problems that are important to users
  • Enable a sustainable system for AutoLLaMo's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing

Styleguides

Git Commit Messages

C# Styleguide

All C# must adhere to C# coding conventions.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Something isn't working.
  • documentation - Improvements or additions to documentation.
  • duplicate - This issue or pull request already exists.
  • enhancement - New feature or request.
  • good first issue - Good for newcomers.
  • help wanted - Extra attention is needed.
  • invalid - This doesn't seem right.
  • question - Further information is requested.
  • security - A security vulnerability has been discovered.
  • wontfix - This will not be worked on.

Thank you for considering contributing to AutoLLaMo!