Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

78 lines (50 loc) · 2.57 KB
Raw

How to Contribute

1. Getting Started

Welcome to the Minerva project! We're excited to have you contribute to our open-source creativity suite. Follow the steps below to get started.

1.1 Join Our Community

Please visit our Discord Server to get started. Our community is there to help you with any questions and provide support.

2. Code of Conduct

To ensure a welcoming and productive environment, we have a Code of Conduct. Please read it before contributing.

How to Contribute

There are several ways you can contribute to Minerva:

3.1 Reporting Bugs

  • Search for existing issues to avoid duplicates.
  • Create a new issue if your problem hasn't been reported yet. Include as much detail as possible.

3.2 Suggesting Features

  • Search for existing feature requests to avoid duplicates.
  • Create a new feature request if your idea hasn't been suggested yet. Provide a clear and detailed description.

3.3 Improving Documentation

  • Check the existing documentation for gaps or outdated information.
  • Submit a pull request with your improvements.

3.4 Contributing Code

  • Fork the repository and create a new branch for your feature or bugfix.
  • Write clear, concise, and well-documented code.
  • Follow the coding standards and conventions used in the project.
  • Include tests for your changes to ensure they work as expected.
  • Submit a pull request and include a detailed description of your changes.

4. Development Setup

4.1 Prerequisites

  • Ensure you have the following installed:
    • Julia
    • VulkanCore.jl
    • Any other dependencies listed in the project

4.2 Setting Up the Project

  1. Clone the repository: git clone https://github.com/sanctus-inc/minerva.git cd minerva
  2. Install dependencies: julia -e 'using Pkg; Pkg.instantiate()'
  3. Run tests to verify your setup: julia -e 'using Pkg; Pkg.test()'

5. Submitting Changes

5.1 Creating a Pull Request

  • Fork the repository and create your branch from main.
  • Write clear commit messages and document your code.
  • Push your changes to your fork.
  • Submit a pull request through GitHub.

5.2 Reviewing Process

  • Your pull request will be reviewed by one of the project maintainers.
  • Make any requested changes and update your pull request accordingly.
  • Once approved, your changes will be merged into the main repository.

Contact

If you have any questions or need further assistance, please reach out on our Discord Server.