Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding contribution.rst #165

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions Contribution.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
Contributing to DISCOVER-Cookbook
===================================

First of all, thank you for considering contributing to DISCOVER-Cookbook! We appreciate your interest and efforts. Below are guidelines to help you get started.

**Table of Contents**

1. [Getting Started](#getting-started)
2. [Code of Conduct](#code-of-conduct)
3. [How to Contribute](#how-to-contribute)
4. [Reporting Issues](#reporting-issues)
5. [Pull Requests](#pull-requests)
6. [Coding Standards](#coding-standards)
7. [Community Support](#community-support)

Getting Started
---------------

1. Fork the repository and clone it to your local machine.
2. Set up your development environment according to our [Setup Guide](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/README.md).
3. Choose an issue to work on from the [issue tracker](https://github.com/numfocus/DISCOVER-Cookbook/issues) or propose your own feature.

Code of Conduct
---------------

By participating in this project, you agree to abide by the [Code of Conduct](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CODE_OF_CONDUCT.md). Please read it to understand the standards for behavior expected as part of this community.

How to Contribute
-----------------

- **Bug Fixes**: Look through the issue tracker for bugs and try fixing them.
- **New Features**: If you have an idea for a new feature, discuss it with the maintainers first. Create a new issue to propose changes.
- **Documentation**: Improve existing documentation or create new documentation. Good documentation is crucial for any project.

Reporting Issues
----------------

- Check if the issue has already been reported by searching the issue tracker.
- Open a new issue and provide a detailed description of the problem.
- Include steps to reproduce the issue, expected behavior, and screenshots if possible.

Pull Requests
-------------

- Ensure your code follows the project's coding standards.
- Test your changes thoroughly before submitting a pull request.
- Write clear and concise commit messages.
- Reference the issue you are addressing in your pull request description.
- Submit your pull request to the appropriate branch (usually `main` or `dev`).

Coding Standards
----------------

- Follow the coding style guidelines specified in the [Coding Standards].
- Ensure your code is well-documented with comments and adheres to best practices.

Community Support
-----------------

- Join our [discussion forum]([email protected]) to ask questions, share ideas, and get support from the community.


We are excited to see your contributions and look forward to working with you!
Loading