-
Notifications
You must be signed in to change notification settings - Fork 751
chore: add contributing guide #311
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,57 @@ | ||
| # Contributing to Electron Fiddle | ||
|
|
||
| Electron Fiddle is a community-driven project, overseen by the [Electron Ecosystem Working | ||
| Group](https://github.com/electron/governance/tree/master/wg-ecosystem#readme). As such, we welcome | ||
| and encourage all sorts of contributions. They include, but are not limited to: | ||
|
|
||
| - Constructive feedback | ||
| - Bug reports / technical issues | ||
| - Documentation changes | ||
| - Feature requests | ||
| - [Pull requests](#filing-pull-requests) | ||
|
|
||
| We strongly suggest that before filing an issue, you search through the existing issues to see | ||
| if it has already been filed by someone else. | ||
|
|
||
| This project is a part of the Electron ecosystem. As such, all contributions to this project follow | ||
| [Electron's code of conduct](https://github.com/electron/electron/blob/master/CODE_OF_CONDUCT.md) | ||
| where appropriate. | ||
|
|
||
| ## Contribution Suggestions | ||
|
|
||
| We use the label [`good first issue`](https://github.com/electron/fiddle/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) in the issue tracker to denote fairly-well-scoped-out bugs or feature requests that the community can pick up and work on. If any of those labeled issues do not have enough information, please feel free to ask constructive questions. (This applies to any open issue.) | ||
|
|
||
| ## Filing Pull Requests | ||
|
|
||
| Here are some things to keep in mind as you file pull requests to fix bugs, add new features, etc.: | ||
|
|
||
| * If you're unfamiliar with forking, branching, and pull requests, please see [GitHub's extensive | ||
| documentation](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests). | ||
| * Travis CI and AppVeyor are used to make sure that any new or changed code meets the project's | ||
| style guidelines, and that the project's testsuite passes for each new commit. | ||
| * Unless it's impractical, please write tests for your changes. This will help us so that we can | ||
| spot regressions much easier. | ||
| * When creating commit messages and pull request titles, please adhere to the [conventional | ||
| commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. | ||
| * Please **do not** bump the version number in your pull requests, the maintainers will do that. | ||
| Feel free to indicate whether the changes require a major, minor, or patch version bump, as | ||
| prescribed by the [semantic versioning specification](http://semver.org/). | ||
|
|
||
| ### Running Fiddle From Source | ||
|
|
||
| ```sh | ||
| git clone https://github.com/electron/fiddle | ||
| cd fiddle | ||
| npm install | ||
| npm start | ||
| ``` | ||
|
|
||
| ### Running Tests | ||
|
|
||
| ```sh | ||
| npm test | ||
| ``` | ||
|
|
||
| ## Release Process | ||
|
|
||
| <!-- TODO @felix add your release process here 😁 --> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call, I should do that 😅 We merge this first and then add it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good to me.