Sha256: d0cac43d5ccd01b61fb8ab53db645dd7322da75def41fc0fee34083225953a1e

Contents?: true

Size: 1.85 KB

Versions: 4

Compression:

Stored size: 1.85 KB

Contents

# Contributing

We are excited that you are interested in contributing to Manifolds! To maintain the quality of our project, we ask that contributors adhere to the following guidelines:

## How to Contribute

- **Familiarize yourself with the project**:
  Spend some time understanding the codebase, philosophy, and design patterns used in Manifolds. Feel free to ask questions if something is unclear.

- ** Check the Issues Tracker**:
  Before creating a new issue, please check the repository's issue tracker to avoid duplicates. If you find an issue you’d like to tackle, comment that you’re working on it.

- **Fork and Clone the Repository**:
  Make a fork of the repository, clone it to your machine, and create a new branch for your contribution.

- **Code Consistency**:
  Follow the coding style and conventions already used in Manifolds. This includes commenting your code where necessary and adhering to the existing naming conventions and file structure.

- **Writing Tests**:
  Add tests that cover the new features or fixes you are introducing. Ensure that all tests pass before submitting a pull request.

- **Documentation**:
  Update the README or documentation with details of changes to the interface, additional environment variables, dependencies, or database migrations, etc.

- **Submit a Pull Request**:
  Push your changes to your fork and submit a pull request to the main Manifolds repository. Provide a clear description of the problem and solution, including any relevant issue numbers.

- **Review and Collaborate**:
  Be open to feedback and make requested modifications to your pull request if needed. Discussion and collaboration often lead to the best solutions.

## Code of Conduct

Respect and professionalism are required at all times; harassment or offensive behavior will not be tolerated. By participating, you are expected to uphold this code.

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
manifolds-0.0.4 docs/CONTRIBUTING.md
manifolds-0.0.3 docs/CONTRIBUTING.md
manifolds-0.0.2 docs/CONTRIBUTING.md
manifolds-0.0.1 docs/CONTRIBUTING.md