Skip to content

Commit

Permalink
docs: update contributing guide to share the same information as the …
Browse files Browse the repository at this point in the history
…other projects (#729)

Co-authored-by: joao <joao.souza@convenia.com.br>
  • Loading branch information
sjoaohenrique and joao authored Oct 14, 2021
1 parent b48742e commit 5fe4155
Showing 1 changed file with 45 additions and 3 deletions.
48 changes: 45 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,48 @@
# Contributing

In favor of active development we accept contributions from everyone. You can contribute by submitting a bug, creating pull requests or even by improving documentation.
AdonisJs is a community driven project. You are free to contribute in any of the following ways.

Below is the guide to be followed strictly before submitting your pull requests.
https://preview.adonisjs.com/code-of-conduct
- [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.

## 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](https://github.com/conventional-changelog/conventional-changelog) 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](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.

## Report security issues

All of the security issues, must be reported via [email](mailto:virk@adonisjs.com) and not using any of the public channels. [Learn more](https://adonisjs.com/docs/security-introduction) about the security policy

## 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.

0 comments on commit 5fe4155

Please sign in to comment.