forked from GrapesJS/grapesjs
-
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
Showing
2 changed files
with
53 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,52 @@ | ||
# Contribute | ||
|
||
## Introduction | ||
|
||
First of all, thank you for considering contributing to GrapesJS! | ||
|
||
We welcome any type of contribution, not only code. Like for example: | ||
- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open) | ||
- **Marketing**: writing blog posts, howto's, tutorials, etc. | ||
- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, etc. | ||
- **Money**: We welcome financial contributions in full transparency on our [Open Collective]. | ||
|
||
|
||
## Your First Contribution | ||
|
||
Working on your first Pull Request? You can learn how from this **free** series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). | ||
|
||
|
||
## Submitting code | ||
|
||
Any code change should be submitted as a pull request. Before start working on something make always a search in opened issues and pull requests, this might help you to avoid waisting time. | ||
|
||
A pull request could be a bug fix, new feature and much more, but in all cases, **open a new issue** and talk about what you want to do. Often happens to work on something already fixed (ready to release) or in progress. | ||
|
||
The title should be brief but comprehensive, the description contains a link to the opened issue and the proposed solution. The pull request should contain tests whenever possible. Keep in mind that the bigger is the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. | ||
|
||
|
||
## Styleguide | ||
|
||
The code is auto formatted with [prettier](https://github.com/prettier/prettier) on any commit, therefore you can write in any style you prefer | ||
|
||
|
||
## Expenses | ||
|
||
Anyone can file an expense (code, marketing, etc.) via our [Open Collective]. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed. | ||
|
||
Before submitting an expense contact core contributors via the current active chat room ([Discord](https://discord.gg/QAbgGXq)) and explain your intents | ||
|
||
|
||
## Questions | ||
|
||
If you have any questions, create an [issue](https://github.com/artf/grapesjs/issues) (protip: do a quick search first to see if someone else didn't ask the same question before!). | ||
|
||
|
||
|
||
## Credits | ||
|
||
Thank you to all the people who have already contributed to GrapesJS! | ||
<a href="/artf/grapesjs/graphs/contributors"><img src="https://opencollective.com/grapesjs/contributors.svg?width=890" /></a> | ||
|
||
|
||
[Open Collective]: <https://opencollective.com/grapesjs> |
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