Skip to content

Latest commit

聽

History

History
37 lines (19 loc) 路 2.45 KB

CONTRIBUTING.md

File metadata and controls

37 lines (19 loc) 路 2.45 KB
Raw

Contributing to Zenith

Thank you for your interest in contributing to Zenith! This document provides some guidelines to help ensure that your contributions are accepted.

Getting Started

Before you start contributing, it's a good idea to set up a development environment and familiarize yourself with the Zenith codebase. Check out the README.md and Configuration.md for instructions on how to set up and configure Zenith.

Ways to Contribute

There are many ways you can contribute to Zenith:

  • Code contributions: If you're a developer and want to contribute code, please check out the open issues on GitHub. If you have an idea for a new feature, feel free to open a new issue.

  • Documentation: If you enjoy writing, contributing to the Zenith documentation is a great way to help. Whether it's updating existing documentation or creating new guides, your contributions are welcome.

  • Bug reports: If you encounter a bug in Zenith, please open an issue on GitHub. Be sure to include as much information as possible to help us reproduce and fix the issue.

  • Feature requests: If you have an idea for a new feature or improvement, please open an issue on GitHub.

Code of Conduct

We are committed to providing a welcoming and safe environment for all contributors. Please read and adhere to our Code of Conduct.

Pull Requests

When you're ready to submit your contribution, please create a pull request on GitHub. Here are some guidelines for pull requests:

  • Branch naming: Please name your branch according to the following format: feature/your-feature-name for new features, bugfix/your-bugfix-description for bug fixes, and docs/your-docs-description for documentation updates.

  • Commit messages: Please write clear, concise commit messages that explain what your changes do. This makes it easier for maintainers to review your changes and understand the history of the project.

  • Testing: Please include tests for your changes whenever possible. This helps ensure that your changes don't break existing functionality and that they work as expected.

Conclusion

Contributions from the community are a big part of what makes open source software great. Thank you for considering contributing to Zenith. We look forward to seeing what you create!