Skip to content

CONTRIBUTE.md

Latest commit

 

History

History
29 lines (20 loc) · 1.71 KB

CONTRIBUTE.md

File metadata and controls

29 lines (20 loc) · 1.71 KB

How to Contribute

We welcome contributions from everyone! Contributions to sunhat are released under the terms of the MIT License. By submitting a pull request, you agree to license your contribution under this license.

Reporting Bugs

If you find a bug, please open an issue on our GitHub repository. When you are creating a bug report, please include:

  • A clear and descriptive title.
  • A detailed description of the problem, including the expected and actual behavior.
  • Steps to reproduce the bug.
  • Information about your environment (e.g., operating system, sunhat version).

Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing one, please open an issue to discuss it. This allows us to coordinate our efforts and prevent duplication of work.

Pull Request Process

We follow a standard GitHub fork and pull request workflow.

  1. Fork the repository to your own GitHub account.
  2. Clone your fork to your local machine.
  3. Create a new branch for your changes. It's good practice to name your branch something descriptive, like fix-authentication-bug or add-user-profiles-feature.
  4. Make your changes. Ensure that your code adheres to the project's coding standards.
  5. Write clear and concise commit messages. A good commit message explains why a change was made.
  6. Push your changes to your fork on GitHub.
  7. Open a pull request from your branch to the main branch of the sunhat repository.
  8. Respond to feedback. The project maintainers will review your pull request and may suggest changes. Be open to discussion and be prepared to make further modifications.