Skip to content

Commit

Permalink
Merge pull request #140 from kaytu-io/fix-contribution-guideline
Browse files Browse the repository at this point in the history
fix: add contribution guideline
  • Loading branch information
salehkhazaei authored May 20, 2024
2 parents ef96dec + 58af48d commit 06174b2
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 8 deletions.
34 changes: 26 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,34 @@ Thank you for considering contributing to our open source project! Taking a mome

Adhering to these guidelines demonstrates your respect for the time and effort invested by the developers who manage and contribute to this project. By following these recommendations, you contribute to a smoother collaboration, and in return, you can expect the same level of respect when your issues are addressed or your patches and features are assessed.

## Code guidelines
Client-Side Implementation with CLI (Cobra Packages)
---
<!-- MarkdownTOC autolink="true" -->

When working on the client side, which is implemented using CLI through Cobra packages, refer to [this link](https://github.com/spf13/cobra) for guidance on adding new commands.
for adding new command :
- [Asking Support Questions](#asking-support-questions)
- [Reporting Issues](#reporting-issues)
- [New Idea](#new-idea)
- [Contributing a Pull Request](#contributing-a-pull-request)

1- cmd File Structure:

Inside the cmd directory, you'll find two main files: cost and ingestion. These files are directly related to the cost and ingestion commands in the CLI.
<!-- /MarkdownTOC -->

2- Cost and Ingestion Subsets:
## Asking Support Questions
Please use the repository [discussion forum](https://github.com/kaytu-io/kaytu/discussions) to ask your questions or discuss with other contributors on different subjects or questions around kaytu project.

Within the cmd directory, you can extend functionality by adding desired commands or flags to the cost and ingestion subsets. Follow the structure provided by Cobra packages for seamless integration.
## Reporting Issues
If you believe you have found any issue or defect in the project or the documentations, please make a new issue in the [issues section](https://github.com/kaytu-io/kaytu/issues). You can first start a discussion in the [discussion forum](https://github.com/kaytu-io/kaytu/discussions) if you are not sure about the issue, or you have doubts in it.

## New Idea
If you have a new idea for a feature or modifications in the project, you can create a proposal in the [issues section](https://github.com/kaytu-io/kaytu/issues). Please do not submit a pull request until the project lead accepts the proposal.

## Contributing a Pull Request

I you are looking to get started committing to the project, we suggest you to look into the [issues](https://github.com/kaytu-io/kaytu/issues) and find an easy one to start. We suggest you to submit a [draft pull request](https://github.blog/2019-02-14-introducing-draft-pull-requests/) so we can review your changes and discuss them before it is fully completed.

When you think the changes are ready to be merged to the project, you can create a pull request.

It may take a while for the core maintainer team to completely review the pull request, so we will appreciate if you make our job easier to do so. Here are some things which can help us:
1. Write a clean code.
2. Write helpful comments in the code.
3. Write helpful and short comments in the pull request.
4. Try to only make one change per pull request.
5 changes: 5 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Security Policy

### Reporting a Vulnerability

Please report (suspected) security vulnerabilities in the [issues section](https://github.com/kaytu-io/kaytu/issues). You will receive a response from us within 48 hours. If we can confirm the issue, we will release a patch as soon as possible depending on the complexity of the issue but historically within days.

0 comments on commit 06174b2

Please sign in to comment.