generated from OpenPecha/new-repo-template
-
Notifications
You must be signed in to change notification settings - Fork 0
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
0 parents
commit 34bee0e
Showing
4 changed files
with
226 additions
and
0 deletions.
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,16 @@ | ||
name: Set Default Branch Protection Rules | ||
|
||
on: | ||
push: | ||
branches: | ||
- main # Trigger this workflow on pushes to the main branch | ||
|
||
jobs: | ||
set-protection: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Set Main Branch Protection Rule | ||
if: ${{ github.run_number == 1 }} | ||
run: | | ||
git clone https://github.com/OpenPecha/rules.git | ||
python rules/set_branch_protection_rules.py $GITHUB_REPOSITORY main ${{ secrets.ADMIN_GITHUB_TOKEN }} |
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,55 @@ | ||
|
||
# Contributing to OpenPecha projects | ||
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: | ||
|
||
- Reporting a bug | ||
- Discussing the current state of the code | ||
- Submitting a fix | ||
- Proposing new features | ||
- Becoming a maintainer | ||
|
||
## 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://guides.github.com/introduction/flow/index.html), 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://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: | ||
|
||
1. Fork the repo and create your branch from `main`. | ||
2. If you've added code that should be tested, add tests. | ||
3. If you've changed APIs, update the documentation. | ||
4. Ensure the test suite passes. | ||
5. Make sure your code lints. | ||
6. Issue that pull request! | ||
|
||
## Any contributions you make will be under the MIT Software License | ||
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. | ||
|
||
## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues) | ||
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! | ||
|
||
## Write bug reports with detail, background, and sample code | ||
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect. | ||
|
||
**Great Bug Reports** tend to have: | ||
|
||
- A quick summary and/or background | ||
- Steps to reproduce | ||
- Be specific! | ||
- Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing | ||
- 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. I'm not even kidding. | ||
|
||
## Use a Consistent Coding Style | ||
I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) | ||
|
||
* Two spaces for indentation rather than tabs | ||
* You can try running `npm run lint` for style unification | ||
|
||
## License | ||
By contributing, you agree that your contributions will be licensed under its MIT License. | ||
|
||
## References | ||
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.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,7 @@ | ||
Copyright OpenPecha 2023 | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
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,148 @@ | ||
# README | ||
|
||
> **Note:** This readme template is based on one from the [Good Docs Project](https://thegooddocsproject.dev). You can find it and a guide to filling it out [here](https://gitlab.com/tgdp/templates/-/tree/main/readme). (_Erase this note after filling out the readme._) | ||
<h1 align="center"> | ||
<br> | ||
<a href="https://openpecha.org"><img src="https://avatars.githubusercontent.com/u/82142807?s=400&u=19e108a15566f3a1449bafb03b8dd706a72aebcd&v=4" alt="OpenPecha" width="150"></a> | ||
<br> | ||
</h1> | ||
|
||
## _Project Name_ | ||
_The project name should match its code's capability so that new users can easily understand what it does._ | ||
|
||
## Owner(s) | ||
|
||
_Change to the owner(s) of the new repo. (This template's owners are:)_ | ||
- [@ngawangtrinley](https://github.com/ngawangtrinley) | ||
- [@mikkokotila](https://github.com/mikkokotila) | ||
- [@evanyerburgh](https://github.com/evanyerburgh) | ||
|
||
|
||
## Table of contents | ||
<p align="center"> | ||
<a href="#project-description">Project description</a> • | ||
<a href="#who-this-project-is-for">Who this project is for</a> • | ||
<a href="#project-dependencies">Project dependencies</a> • | ||
<a href="#instructions-for-use">Instructions for use</a> • | ||
<a href="#contributing-guidelines">Contributing guidelines</a> • | ||
<a href="#additional-documentation">Additional documentation</a> • | ||
<a href="#how-to-get-help">How to get help</a> • | ||
<a href="#terms-of-use">Terms of use</a> | ||
</p> | ||
<hr> | ||
|
||
## Project description | ||
_Use one of these:_ | ||
|
||
With _Project Name_ you can _verb_ _noun_... | ||
|
||
_Project Name_ helps you _verb_ _noun_... | ||
|
||
|
||
## Who this project is for | ||
This project is intended for _target user_ who wants to _user objective_. | ||
|
||
|
||
## Project dependencies | ||
Before using _Project Name_, ensure you have: | ||
* _Prerequisite 1_ | ||
* _Prerequisite 2_ | ||
* _Prerequisite 3..._ | ||
|
||
|
||
## Instructions for use | ||
Get started with _Project Name_ by _(write the first step a user needs to start using the project. Use a verb to start.)_. | ||
|
||
|
||
### Install _Project Name_ | ||
1. _Write the step here._ | ||
|
||
_Explanatory text here_ | ||
|
||
_(Optional: Include a code sample or screenshot that helps your users complete this step.)_ | ||
|
||
2. _Write the step here._ | ||
|
||
a. _Substep 1_ | ||
|
||
b. _Substep 2_ | ||
|
||
|
||
### Configure _Project Name_ | ||
1. _Write the step here._ | ||
2. _Write the step here._ | ||
|
||
|
||
### Run _Project Name_ | ||
1. _Write the step here._ | ||
2. _Write the step here._ | ||
|
||
|
||
### Troubleshoot _Project Name_ | ||
1. _Write the step here._ | ||
2. _Write the step here._ | ||
|
||
<table> | ||
<tr> | ||
<td> | ||
Issue | ||
</td> | ||
<td> | ||
Solution | ||
</td> | ||
</tr> | ||
<tr> | ||
<td> | ||
_Describe the issue here_ | ||
</td> | ||
<td> | ||
_Write solution here_ | ||
</td> | ||
</tr> | ||
<tr> | ||
<td> | ||
_Describe the issue here_ | ||
</td> | ||
<td> | ||
_Write solution here_ | ||
</td> | ||
</tr> | ||
<tr> | ||
<td> | ||
_Describe the issue here_ | ||
</td> | ||
<td> | ||
_Write solution here_ | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
|
||
Other troubleshooting supports: | ||
* _Link to FAQs_ | ||
* _Link to runbooks_ | ||
* _Link to other relevant support information_ | ||
|
||
|
||
## Contributing guidelines | ||
If you'd like to help out, check out our [contributing guidelines](/CONTRIBUTING.md). | ||
|
||
|
||
## Additional documentation | ||
_Include links and brief descriptions to additional documentation._ | ||
|
||
For more information: | ||
* [Reference link 1](#) | ||
* [Reference link 2](#) | ||
* [Reference link 3](#) | ||
|
||
|
||
## How to get help | ||
* File an issue. | ||
* Email us at openpecha[at]gmail.com. | ||
* Join our [discord](https://discord.com/invite/7GFpPFSTeA). | ||
|
||
|
||
## Terms of use | ||
_Project Name_ is licensed under the [MIT License](/LICENSE.md). |