Skip to content
This repository has been archived by the owner on Oct 31, 2024. It is now read-only.

Latest commit

 

History

History
98 lines (64 loc) · 4.58 KB

CONTRIBUTING.md

File metadata and controls

98 lines (64 loc) · 4.58 KB

Contributing to Obsekio

All types of contributions are encouraged and valued, whether directly related to the codebase or not. This document outlines the process for contributing to the Obsekio project.

Even if you are not a developer, you can contribute to the project by:

  • Reporting bugs
  • Suggesting new features
  • Writing documentation
  • Providing feedback on the project
  • Improving the project's accessibility
  • Designing new user interfaces

We also welcome starring the project on Github, sharing the project with others on social media, and contributing to the overall discussion of the project's future.

If you have any questions or need help, please open an issue on the Github repository or contact the maintainers directly.

How Can I Contribute?

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project's license.

Please note, this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Reporting Bugs

Before Submitting a Bug Report

A good bug report helps us understand the problem you are experiencing and how to reproduce it. Please consider these before submitting a bug report:

  • Check the open issues to see if the bug has already been reported.
  • Check to see if the issue has been discussed on Stack Overflow or other forums.

How Do I Submit a Good Bug Report?

Please follow these steps when submitting a bug report:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps to reproduce the problem.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps and explain what you expected to happen.
  • Explain the problem and include any error messages that appeared.
  • Include screenshots, logs, or code snippets to help explain the problem.
  • Describe the environment where the bug occurred, including the operating system, browser, and any other relevant information.
  • Include any additional information that may be helpful in understanding the problem.

Bug reports can be filed in the project's issue tracker on Github. Create a new issue and use the Bug Report template to provide the necessary information.

Suggesting Enhancements

When suggesting an enhancement, please provide as much detail as possible to help us understand your request. This includes:

  • A clear and descriptive title for the enhancement.
  • A detailed description of the enhancement, including the problem you are trying to solve.
  • A description of the current behavior and how the enhancement would improve it.
  • A description of the new behavior you would like to see.
  • Any relevant examples or use cases that demonstrate the enhancement.

Enhancements can be suggested in the project's issue tracker on Github. Create a new issue and use the Feature Request template to record the details of your suggestion.

Writing Code

To contribute code to the project, please follow these steps:

  • Fork the repository on Github.
  • Create a new branch from the main branch.
  • Make your changes in the new branch.
  • Write tests for your changes.
  • Run the tests to ensure they pass.
  • Commit your changes and push them to your fork.
  • Create a pull request to merge your changes into the main branch.

Pull Requests

When submitting a pull request, please follow these guidelines:

  • Use a clear and descriptive title for the pull request.
  • Provide a detailed description of the changes you are making.
  • Reference any related issues in the description.
  • Include screenshots, logs, or code snippets to help explain the changes.
  • Ensure that the code is well-documented and follows the project's coding standards.

Code Style Conventions

We use the conventions outlined in the Ruby Style Guide. Please follow these conventions when writing code for the project.

Before submitting a pull request, please run the following commands to ensure that your code follows the project's coding standards:

bundle exec rubocop

Any issues reported by Rubocop should be addressed before submitting the pull request.

Attribution

We've used templates and boilerplate text sourced from https://contributing.md/