Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 2.61 KB
Raw

Contributing

AdonisJS is a community driven project. You are free to contribute in any of the following ways.

Coding style

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

We appreciate every time you report a bug in the framework or related libraries. However, taking time to submit a PR can help us in fixing bugs quickly and ensure a healthy and stable eco-system.

Go through the following points, before creating a new PR.

  1. Create an issue discussing the bug or short-coming in the framework.
  2. Once approved, go ahead and fork the REPO.
  3. Make sure to start from the develop, since this is the upto date branch.
  4. Make sure to keep commits small and relevant.
  5. We follow conventional-commits to structure our commit messages. Instead of running git commit, you must run npm commit, which will show you prompts to create a valid commit message.
  6. Once done with all the changes, create a PR against the develop branch.

Share an RFC for new features or big changes

Sharing PR's for small changes works great. However, when contributing big features to the framework, it is required to go through the RFC process.

What is an RFC?

RFC stands for Request for Commits, a standard process followed by many other frameworks including Ember, yarn and rust.

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 Pull Request on 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 and not using any of the public channels.

Be a part of community

We welcome you to participate in GitHub Discussion and the AdonisJS Discord Server. You are free to ask your questions and share your work or contributions made to AdonisJS eco-system.