Skip to content

Commit 59f5559

Browse files
MeldironMeldiron
committed
Add main readmes
1 parent 7a04a67 commit 59f5559

File tree

4 files changed

+245
-2
lines changed

4 files changed

+245
-2
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity, expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Contributing
2+
3+
We would ❤️ you to contribute to Appwrite and help make it better! We want contributing to Appwrite to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, and new docs, as well as updates and tweaks, blog posts, workshops, and more.
4+
5+
## How to Start?
6+
7+
If you are worried or don’t know where to start, check out the next section that explains what kind of help we could use and where you can get involved. You can send your questions to [@appwrite](https://twitter.com/appwrite) on Twitter or to anyone from the [Appwrite team on Discord](https://appwrite.io/discord). You can also submit an issue, and a maintainer can guide you!
8+
9+
## Code of Conduct
10+
11+
Help us keep Appwrite open and inclusive. Please read and follow our [Code of Conduct](https://github.com/appwrite/.github/blob/main/CODE_OF_CONDUCT.md).
12+
13+
## Submit a Pull Request 🚀
14+
15+
Branch naming convention is as following
16+
17+
`TYPE-ISSUE_ID-DESCRIPTION`
18+
19+
example:
20+
21+
```
22+
doc-548-submit-a-pull-request-section-to-contribution-guide
23+
```
24+
25+
When `TYPE` can be:
26+
27+
- **feat** - a new feature
28+
- **doc** - documentation only changes
29+
- **cicd** - changes related to CI/CD system
30+
- **fix** - a bug fix
31+
- **refactor** - code change that neither fixes a bug nor adds a feature
32+
33+
**All PRs must include a commit message with the description of the changes made!**
34+
35+
For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to:
36+
37+
1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date.
38+
39+
```
40+
$ git pull
41+
```
42+
43+
2. Create a new branch from `master` like: `doc-548-submit-a-pull-request-section-to-contribution-guide`.<br/>
44+
45+
```
46+
$ git checkout -b [name_of_your_new_branch]
47+
```
48+
49+
3. Work - commit - repeat (make sure you're on the correct branch!)
50+
51+
4. Push changes to GitHub.
52+
53+
```
54+
$ git push origin [name_of_your_new_branch]
55+
```
56+
57+
5. Submit your changes for review
58+
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
59+
6. Start a Pull Request
60+
Now submit the pull request and click on `Create pull request`.
61+
7. Get a code review approval/reject.
62+
8. After approval, merge your PR.
63+
9. GitHub will automatically delete the branch after the merge is done. (they can still be restored).
64+
65+
### File Structure
66+
67+
```bash
68+
.
69+
├── node # Runtime name
70+
│ ├── starter # Template name
71+
│ │ ├── ... # Runtime & template specific files
72+
│ │ └── README.md # Template documentation
73+
│ └── ... # More templates
74+
├── ... # More runtimes
75+
├── _README_TEMPLATE.md # README template to use for new templates
76+
└── ... # License and documentation
77+
```
78+
79+
## Coding Standards
80+
81+
All code in templates should be formatted. Use formatter that is most common in runtime for which you are developing the template. If there isn't popular one in a runtime, you can use [Prettier](https://prettier.io/).
82+
83+
## Security and Privacy
84+
85+
Security and privacy are extremely important to Appwrite, developers, and users alike. Make sure to follow the best industry standards and practices.
86+
87+
## Dependencies
88+
89+
Usage of dependencies is welcomed for purpose of simplifying template code. Please only use libraries that are well-known, and popular.
90+
91+
## Introducing New Templates
92+
93+
We would 💖 you to contribute to Appwrite, but we also want to ensure Appwrite is loyal to its vision and mission statement 🙏.
94+
95+
For us to find the right balance, please open an issue explaining your template idea before introducing a new pull request.
96+
97+
This will allow the Appwrite community to sufficiently discuss the new template value.
98+
99+
## Tutorials
100+
101+
From time to time, our team will add tutorials that will help contributors find their way in the Appwrite source code. Below is a list of currently available tutorials:
102+
103+
- [Adding Function Template](./docs/tutorials/add-function-template.md)
104+
105+
## Other Ways to Help
106+
107+
Pull requests are great, but there are many other ways you can help Appwrite.
108+
109+
### Blogging & Speaking
110+
111+
Blogging, speaking about, or creating tutorials about one of Appwrite’s many features are great ways to get the word out about Appwrite. Mention [@appwrite](https://twitter.com/appwrite) on Twitter and/or [email [email protected]](mailto:[email protected]) so we can give pointers and tips and help you spread the word by promoting your content on the different Appwrite communication channels. Please add your blog posts and videos of talks to our [Awesome Appwrite](https://github.com/appwrite/awesome-appwrite) repo on GitHub.
112+
113+
### Presenting at Meetups
114+
115+
We encourage our contributors to present at meetups and conferences about your Appwrite projects. Your unique challenges and successes in building things with Appwrite can provide great speaking material. We’d love to review your talk abstract/CFP, so get in touch with us if you’d like some help!
116+
117+
### Sending Feedbacks and Reporting Bugs
118+
119+
Sending feedback is a great way for us to understand your different use cases of Appwrite better. If you had any issues, bugs, or want to share your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA).
120+
121+
### Submitting New Ideas
122+
123+
If you think Appwrite could use a new feature, please open an issue on our GitHub repository, stating as much information as you have about your new idea and its implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature.
124+
125+
### Improving Documentation
126+
127+
Submitting documentation updates, enhancements, designs, or bug fixes, as well as spelling or grammar fixes is much appreciated.
128+
129+
### Helping Someone
130+
131+
Consider searching for Appwrite on Discord, GitHub, or StackOverflow to help someone who needs help. You can also help by teaching others how to contribute to Appwrite's repo!

‎README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
1-
# templates-for-node
2-
Repository to hold all the function starter templates for Node.js
1+
# 📚 Appwrite Templates
2+
3+
[![We're Hiring](https://img.shields.io/static/v1?label=We're&message=Hiring&color=blue&style=flat-square)](https://appwrite.io/company/careers)
4+
[![Hacktoberfest](https://img.shields.io/static/v1?label=hacktoberfest&message=ready&color=191120&style=flat-square)](https://hacktoberfest.appwrite.io)
5+
[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord?r=Github)
6+
[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
7+
8+
Templates for [Appwrite](https://appwrite.io/) Functions. These templates can be used as starters for your functions, or for learning purposes.
9+
10+
# List of Templates
11+
12+
<!-- TABLE:START -->
13+
<!-- TABLE:END -->
14+
15+
✅ = Done - Function is implemented in this runtime.
16+
❌ = Missing - Function isn't implemented in this runtime yet. Contributions are welcomed.
17+
18+
## Contributing
19+
20+
All code contributions - including those of people having commit access - must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.
21+
22+
All functions should have the exactly same functionality as their other language counterparts and if possible you should avoid using any third-party libraries to keep the functions simple and secure.
23+
24+
We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the [contribution guide](https://github.com/open-runtimes/.github/blob/main/CONTRIBUTING.md).
25+
26+
27+
## Security
28+
29+
For security issues, kindly email us at [[email protected]](mailto:[email protected]) instead of posting a public issue on GitHub.
30+
31+
## Discord Server
32+
33+
Join our live [Discord server](https://appwrite.io/discord) for more help, ideas, and discussions.
34+
35+
## License
36+
37+
This repository is available under the [MIT License](./LICENSE).

‎docs/tutorials/add-function-template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# TODO

0 commit comments

Comments
 (0)