Skip to content

Commit

Permalink
started working on the budget planning application
Browse files Browse the repository at this point in the history
  • Loading branch information
@ibilalkayy
ibilalkayy committed Feb 24, 2024
0 parents commit d8eb6b7
Show file tree
Hide file tree
Showing 15 changed files with 679 additions and 0 deletions.
53 changes: 53 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
Certainly! Below is a template for a Code of Conduct that you can use for your flow project. Feel free to customize it to suit the specific needs and values of your community.

---

# Flow Code of Conduct

## Introduction

Flow is an open-source project and a community that values diversity, inclusion, and respect. This Code of Conduct outlines our expectations for all contributors, maintainers, and participants in the flow community.

## Our Pledge

In the interest of fostering an open and welcoming environment, we pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Expected Behavior

We expect all community members to:

- Be respectful and considerate of others' opinions, ideas, and contributions.
- Use welcoming and inclusive language.
- Be open to constructive feedback and criticism.
- Show empathy towards others.
- Focus on resolving conflicts in a positive and collaborative manner.

## Unacceptable Behavior

Unacceptable behaviors include, but are not limited to:

- Harassment, discrimination, or intimidation in any form.
- Offensive comments or behaviors related to age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
- Deliberate intimidation, stalking, or following.
- Any form of unwanted attention or unwelcome physical contact.
- Engaging in behavior that disrupts the community or hinders its positive development.

## Reporting Violations

If you witness or experience behavior that violates this Code of Conduct, please report it promptly to [maintainers' email or contact method].

## Consequences of Unacceptable Behavior

Unacceptable behavior will not be tolerated within the flow community. Anyone engaged in such behavior may be asked to stop, be temporarily or permanently excluded from the community, or face other consequences as deemed appropriate by the project maintainers.

## Scope

This Code of Conduct applies to all community spaces associated with the flow project, including but not limited to GitHub repositories, discussions, social media, and events.

## Acknowledgment

By participating in the flow community, you agree to abide by this Code of Conduct. Project maintainers have the right and responsibility to address any behavior that they deem inappropriate, threatening, offensive, or harmful.

## Contact

If you have concerns or inquiries about this Code of Conduct, please contact me through my [Twitter](https://x.com/ibilalkayy) account.
78 changes: 78 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Contributing to Flow

Thank you for considering contributing to flow! Whether you want to report a bug, suggest an enhancement, or contribute code, your efforts are appreciated. This guide outlines the process for contributing to wecli.

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [How Can I Contribute?](#how-can-i-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Setting Up Your Development Environment](#setting-up-your-development-environment)
- [Making Changes](#making-changes)
- [Submitting a Pull Request](#submitting-a-pull-request)
- [Code Review Process](#code-review-process)
- [Conclusion](#conclusion)

## Code of Conduct

Before getting started, please read and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). We aim to create a welcoming and inclusive environment for everyone.

## How Can I Contribute?

There are various ways you can contribute to flow:

- Reporting bugs
- Suggesting enhancements
- Writing code improvements
- Improving documentation

Choose the contribution method that best fits your skills and interests.

## Reporting Bugs

If you encounter a bug or unexpected behavior, please [open an issue](https://github.com/ibilalkayy/flow/issues) and provide details about the problem. Include steps to reproduce the issue and any relevant information about your environment.

## Suggesting Enhancements

If you have ideas for new features or improvements, [open an issue](https://github.com/ibilalkayy/flow/issues) and describe the enhancement you're proposing. Discussion on proposed enhancements is welcome before any code is written.

## Setting Up Your Development Environment

To contribute code to flow, you'll need to set up your development environment:

1. Fork the [fork repository](https://github.com/ibilalkayy/flow) on GitHub.
2. Clone your forked repository to your local machine.
3. Install Go if you haven't already: [https://golang.org/dl/](https://golang.org/dl/).
4. Run `go install` in the project directory to build and install flow.

## Making Changes

Before making changes, create a new branch for your work:

```bash
git checkout -b my-feature-branch
```

Make your changes, commit them with clear messages, and push the branch to your fork on GitHub:

```bash
git push origin my-feature-branch
```

## Submitting a Pull Request

When you're ready to submit your changes, open a pull request:

1. Navigate to the [flow pull request page](https://github.com/ibilalkayy/flow/pulls).
2. Click the "New pull request" button.
3. Select your branch as the compare branch.
4. Follow the pull request template and provide information about your changes.

## Code Review Process

Your pull request will be reviewed by maintainers and contributors. Expect feedback and be prepared to address any suggested changes. Once approved, your changes will be merged into the main branch.

## Conclusion

Thank you for considering contributing to flow! Your contributions help improve the tool for everyone. If you have any questions, feel free to reach out to me through [Twitter](https://x.com/ibilalkayy). Happy coding!
201 changes: 201 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading

0 comments on commit d8eb6b7

Please sign in to comment.