-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4377461
commit 16817a3
Showing
5 changed files
with
118 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Handwrite - Code of Conduct | ||
|
||
Please refer to our [Builtree Community Code of Conduct](https://github.com/bui`ltree/builtree/blob/main/governance/CODE-OF-CONDUCT.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing | ||
|
||
This Project welcomes contributions, suggestions, and feedback. All contributions, suggestions, and feedback you submitted are accepted under the Project's license. You represent that if you do not own copyright in the code that you have the authority to submit it under the Project's license. All feedback, suggestions, or contributions are not confidential. | ||
|
||
## Organisation Contributing | ||
The Project abides by the Organization's code of conduct and trademark policy. Please refer to our [Builtree Contributing Guidelines](https://github.com/bui`ltree/builtree/blob/main/governance/CODE-OF-CONDUCT.md). | ||
|
||
# Contributing to Handwrite | ||
|
||
Contributions can come in many forms, we always need help in improving the project. If you find issues with the documentation, usability, code, or even a question, please open an [issue](https://github.com/builtree/handwrite/issues) to let us know and or post in [Builtree Discord Server](https://discord.gg/9BtRZhJb9G)'s relevant channel. | ||
|
||
## We Develop with Github | ||
We use github to host code, to track issues and feature requests, as well as accept pull requests. | ||
|
||
## We Use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests | ||
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests: | ||
|
||
1. Make sure there is an issue existing for your pull request. If not, get in touch with a maintainer/mentor and create one. | ||
2. Make sure that issue has been acknowledged by the maintainer/mentor before you start working. | ||
3. Fork the repo and create your branch from `main`. | ||
4. If you've added code that should be tested, add tests (if the project supports tests or has a testing guideline). Ensure the test suite passes. | ||
5. If you've changed a feature,API,etc., update the documentation. | ||
6. Make sure your code lints. | ||
7. Properly attach that pull request to its issue! | ||
|
||
## Any contributions you make will be under the MIT License | ||
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](./LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern. | ||
|
||
## Report bugs using Github's [issues](https://github.com/builtree/handwrite/issues) | ||
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/builtree/handwrite/issues/new/choose); it's that easy! | ||
|
||
## Write bug reports with detail | ||
Make sure the bug reports are detaild and follow the bug issue template in the project. | ||
|
||
**Great Bug Reports** tend to have: | ||
|
||
- A quick summary and/or background | ||
- Steps to reproduce | ||
- Be specific! | ||
- What you expected would happen | ||
- What actually happens | ||
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) | ||
|
||
People *love* thorough bug reports! | ||
|
||
## Coding Style | ||
|
||
* Style point 1 | ||
* Style point 2 | ||
|
||
--- | ||
Part of MVG-0.1-beta. | ||
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Governance Policy | ||
|
||
This document provides the governance policy for the Project. Maintainers agree to this policy and to abide by all Project polices, including the code of conduct, trademark policy, and antitrust policy by adding their name to the maintainers.md file. | ||
|
||
## 1. Roles. | ||
|
||
This project **may** include the following roles. Additional roles may be adopted and documented by the Project. | ||
|
||
**1.1. Maintainers**. Maintainers are responsible for organizing activities around developing, maintaining, and updating the Project. Maintainers are also responsible for determining consensus. This Project may add or remove Maintainers with the approval of the current Maintainers. | ||
|
||
**1.2. Open Source Product Managers**. (OSPMs). OSPMs are responsible for understanding the project completely, researching and determining a constantly evolving vision/roadmap the project can follow. OSPMs will help those involved in the project priotize what is important moving forward with the project. | ||
|
||
**1.3. Mentors**. Mentors are responsible for mentoring contributors by engaging the contributors and helping them with their contributions by providing subtle guidance. Mentors can also be contributors in the project. | ||
|
||
**1.4. Contributors**. Contributors are those that have made contributions to the Project. | ||
|
||
## 2. Decisions. | ||
|
||
**2.1. Consensus-Based Decision Making**. Projects make decisions through consensus of the Maintainers. While explicit agreement of all Maintainers is preferred, it is not required for consensus. Rather, the Maintainers will determine consensus based on their good faith consideration of a number of factors, including the dominant view of the Contributors and nature of support and objections. The Maintainers will document evidence of consensus in accordance with these requirements. | ||
|
||
**2.2. Appeal Process**. Decisions may be appealed by opening an issue and that appeal will be considered by the Maintainers in good faith, who will respond in writing within a reasonable time. If the Maintainers deny the appeal, the appeal my be brought before the Organization Steering Committee, who will also respond in writing in a reasonable time. | ||
|
||
## 3. How We Work. | ||
|
||
**3.1. Openness**. Participation is open to anyone who is directly and materially affected by the activity in question. There shall be no undue financial barriers to participation. | ||
|
||
**3.2. Balance**. The development process should balance the interests of Contributors and other stakeholders. Contributors from diverse interest categories shall be sought with the objective of achieving balance. | ||
|
||
**3.3. Coordination and Harmonization**. Good faith efforts shall be made to resolve potential conflicts or incompatibility between releases in this Project. | ||
|
||
**3.4. Consideration of Views and Objections**. Prompt consideration shall be given to the written views and objections of all Contributors. | ||
|
||
**3.5. Written procedures**. This governance document and other materials documenting this project's development process shall be available to any interested person. | ||
|
||
## 4. No Confidentiality. | ||
|
||
Information disclosed in connection with any Project activity, including but not limited to meetings, contributions, and submissions, is not confidential, regardless of any markings or statements to the contrary. | ||
|
||
## 5. Trademarks. | ||
|
||
Any names, trademarks, logos, or goodwill developed by and associated with the Project (the "Marks") are controlled by the Organization. Maintainers may only use these Marks in accordance with the Organization's trademark policy. If a Maintainer resigns or is removed, any rights the Maintainer may have in the Marks revert to the Organization. | ||
|
||
## 6. Amendments. | ||
|
||
Amendments to this governance policy may be made by affirmative vote of 2/3 of all Maintainers, with approval by the Organization's Steering Committee. | ||
|
||
--- | ||
Part of MVG-0.1-beta. | ||
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Maintainers | ||
|
||
This document lists the Maintainers of the Project. Maintainers may be added once approved by the existing maintainers as described in the Governance document. By adding your name to this list you are agreeing to abide by the Project governance documents and to abide by all of the Organization's polices, including the code of conduct, trademark policy, and antitrust policy. If you are participating because of your affiliation with another organization (designated below), you represent that you have the authority to bind that organization to these policies. | ||
|
||
| **NAME** | **Organization** | **Username** | | ||
| --- | --- | --- | | ||
| Saksham Arora | Builtree | [sakshamarora1](https://github.com/sakshamarora1) | | ||
| Yash Lamba | Builtree | [yashlamba](https://github.com/yashlamba) | | ||
|
||
--- | ||
Part of MVG-0.1-beta. | ||
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/). |