-
-
Notifications
You must be signed in to change notification settings - Fork 198
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
bfcc2e6
commit 64bffa4
Showing
13 changed files
with
67 additions
and
63 deletions.
There are no files selected for viewing
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -1,16 +1,16 @@ | ||
# Contributing | ||
|
||
AdonisJs is a community driven project. You are free to contribute in any of the following ways. | ||
AdonisJS is a community driven project. You are free to contribute in any of the following ways. | ||
|
||
- [Coding style](#coding-style) | ||
- [Fix bugs by creating PR's](#fix-bugs-by-creating-prs) | ||
- [Share an RFC for new features or big changes](#share-an-rfc-for-new-features-or-big-changes) | ||
- [Report security issues](#report-security-issues) | ||
- [Be a part of the community](#be-a-part-of-community) | ||
- [Coding style](coding-style) | ||
- [Fix bugs by creating PR's](fix-bugs-by-creating-prs) | ||
- [Share an RFC for new features or big changes](share-an-rfc-for-new-features-or-big-changes) | ||
- [Report security issues](report-security-issues) | ||
- [Be a part of the community](be-a-part-of-community) | ||
|
||
## Coding style | ||
|
||
Majority of AdonisJs core packages are written in Typescript. Having a brief knowledge of Typescript is required to contribute to the core. [Learn more](https://adonisjs.com/docs/contribution-guide#_coding_style) about the same. | ||
Majority of AdonisJS core packages are written in Typescript. Having a brief knowledge of Typescript is required to contribute to the core. | ||
|
||
## Fix bugs by creating PR's | ||
|
||
|
@@ -31,18 +31,16 @@ Sharing PR's for small changes works great. However, when contributing big featu | |
|
||
### What is an RFC? | ||
|
||
RFC stands for **Request for Commits**, a standard process followed by many other frameworks including [Ember](https://github.com/emberjs/rfcs), [yarn](https://github.com/yarnpkg/rfcs) and [rust](https://github.com/rust-lang/rfcs). | ||
RFC stands for **Request for Commits**, a standard process followed by many other frameworks including [Ember](https://github.com/emberjs/rfcs), [yarn](https://github.com/yarnpkg/rfcs) and [rust](https://github.com/rust-lang/rfcs). | ||
|
||
In brief, RFC process allows you to talk about the changes with everyone in the community and get a view of the core team before dedicating your time to work on the feature. | ||
|
||
The RFC proposals are created as issues on [adonisjs/rfcs](https://github.com/adonisjs/rfcs) repo. Make sure to read the README to learn about the process in depth. | ||
The RFC proposals are created as Pull Request on [adonisjs/rfcs](https://github.com/adonisjs/rfcs) repo. Make sure to read the README to learn about the process in depth. | ||
|
||
## Report security issues | ||
|
||
All of the security issues, must be reported via [email](mailto:[email protected]) and not using any of the public channels. [Learn more](https://adonisjs.com/docs/security-introduction) about the security policy | ||
All of the security issues, must be reported via [email](mailto:[email protected]) and not using any of the public channels. | ||
|
||
## Be a part of community | ||
|
||
We welcome you to participate in [GitHub Discussion](https://github.com/adonisjs/core/discussions) and the AdonisJs [discord server](https://discord.gg/vDcEjq6). You are free to ask your questions and share your work or contributions made to AdonisJs eco-system. | ||
|
||
We follow a strict [Code of Conduct](https://preview.adonisjs.com/code-of-conduct) to make sure everyone is respectful to each other. | ||
We welcome you to participate in [GitHub Discussion](https://github.com/adonisjs/core/discussions) and the AdonisJS [Discord Server](https://discord.gg/vDcEjq6). You are free to ask your questions and share your work or contributions made to AdonisJS eco-system. |
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
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 |
---|---|---|
@@ -1,5 +1,7 @@ | ||
name: test | ||
on: [push, pull_request] | ||
on: | ||
- push | ||
- pull_request | ||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
This file was deleted.
Oops, something went wrong.
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 was deleted.
Oops, something went wrong.
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