Hugging Face's logo

Spaces:
p3nGu1nZz
/
plasma-arc
Running

App Files Community
plasma-arc / CONTRIBUTE.md
p3nGu1nZz's picture
p3nGu1nZz
✅ Updated our documentation for Plasma Arc Project!
d3bf19d
preview code
|
raw
history blame contribute delete
2.57 kB

Contributing to the Plasma Arc Project

First off, thanks for taking the time to contribute! 😊

The following is a set of guidelines for contributing to the Plasma Arc Project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How to Contribute

Reporting Bugs

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

  • Search for existing issues to avoid duplicates.
  • Use a clear and descriptive title for the issue.
  • Provide as much detail as possible. Include OS version, browser version, and steps to reproduce the bug.

Suggesting Enhancements

To suggest an enhancement, please open an issue in our GitHub Repository. Make sure to describe the enhancement in detail.

  • Use a clear and descriptive title for the issue.
  • Provide a detailed description of the suggested enhancement.
  • Explain why this enhancement would be useful to other users.

Pull Requests

Pull Requests (PRs) are welcome! If you plan to submit a large feature or change, please open an issue first to discuss it with us. This helps avoid duplicated effort and ensures that your contribution fits within the project's scope.

  • Fork the repository to your own GitHub account.
  • Clone the repository to your local machine.
  • Create a branch for your changes.
  • Commit your changes to your branch.
  • Push your branch to your GitHub repository.
  • Create a Pull Request from your branch to the main repository's main branch.

Coding Standards

To ensure consistency throughout the source code, please adhere to the following guidelines:

  • Write clean code and follow the project's code style.
  • Use meaningful commit messages.
  • Include comments for complex code and functions.
  • Write tests for any new features or bug fixes.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Contact

If you have any questions or need further clarification, feel free to reach out via:

  • GitHub Issues: For any general questions or issues.
  • Discord Community: Join our Hugging Face Discord for discussions and support.

Thank you for contributing! 😊