Skip to content

Contribution Guidelines

Mitchell Shiell edited this page May 31, 2023 · 1 revision

Contribution Guidelines

We appreciate your interest in contributing to this project! Please take the time to read and follow these guidelines before submitting your contributions. By participating in this project, you are expected to abide by the Code of Conduct. Please take the time to read it carefully before contributing.

Issues and Feature Requests

Before opening a new issue or feature request, please check if a similar one already exists. If so, please add a comment to the existing issue instead of creating a new one. When submitting an issue or feature request, please include a detailed description of the problem or feature you would like to see, along with any relevant code, error messages, or screenshots. This will help us better understand the issue and respond more efficiently.

Pull Requests

We welcome and encourage pull requests from the community.

Before submitting a pull request, please ensure your code follows these guidelines:

  • The code should be well-documented and readable.
  • The code should be tested.
  • Pull requests should be accompanied by a clear description of the changes made and why they are necessary.

To get started contributing to the Overture-Stack, follow these steps:

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your changes and commit them.
  5. Push your changes to your forked repository.
  6. Create a pull request to the main repository.

When submitting a pull request, please follow these steps:

  1. Fork the repository and create a new branch for your changes.
  2. Make your changes, commit them, and push them to your branch.
  3. Create a pull request detailing your changes and why they are necessary.

We use GitHub issues and pull requests for communication-related to code changes. For general discussion, feel free to join our slack channel.

Thank you for contributing to Overture-Stack!