Skip to content
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

chore(maintenance): add project guides #36

Merged
merged 1 commit into from
Oct 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!--
Thank you for reporting an issue.

This issue tracker is for bugs and issues found within c8.

Please fill in as much of the template below as you're able.

Version: output of `node -v`
Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows)

If possible, please provide code that demonstrates the problem, keeping it as
simple and free of external dependencies as you are able.
-->

* **Version**:
* **Platform**:

<!-- Enter your issue details below this comment. -->
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!--
Thank you for your pull request. Please provide a description above and review
the requirements below.

Bug fixes and new features should include tests and possibly benchmarks.

Contributors guide: https://github.com/bcoe/c8/blob/master/CONTRIBUTING.md
-->

##### Checklist
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
- [ ] `npm test`, tests passing
- [ ] `npm run test:snap` (to update the snapshot)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps add here, if any new tests have been added.

- [ ] tests and/or benchmarks are included
- [ ] documentation is changed or added
53 changes: 53 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contributing to `c8`

The `c8` project welcomes all contributions from anyone willing to work in good faith with other contributors and the community. No contribution is too small and all contributions are valued.

## Issues

- You can open [issues here](https://github.com/bcoe/c8/issues), please follow the template guide.
- You can join the `node-tooling/c8` channel, [follow this link](https://devtoolscommunity.herokuapp.com/) to request for an invite.

## Pull Requests

Pull Requests are the way concrete changes are made to the code, documentation, dependencies, and tools contained in the `c8` repository.

### Setting up your local environment

1. Make sure you have installed the latest version of Node.js
1. Fork this project on Github and clone your fork locally:
```
$ git clone [email protected]:username/c8.git
$ cd c8
$ git remote add upstream https://github.com/bcoe/c8.git
$ git fetch upstream
```
1. Create local branches to work within. These should also be created directly off of the master branch:
```
$ git checkout -b my-branch -t upstream/master
```
1. Make your changes
1. Run tests to make sure all is okay (everything should pass except snapshot):
```
$ npm test
```
1. Now update the snapshot
```
$ npm run test:snap
```
2. If all is passing, commit your changes.
3. As a best practice, once you have committed your changes, it is a good idea to use git rebase (not git merge) to synchronize your work with the main repository:
```
$ git fetch upstream
$ git rebase upstream/master
```
1. Run tests again to make sure all is okay
1. Push:
```
$ npm test
```
1. Open the pull request, see details in the template.
1. Make any necessary changes after review.

## Note

This guide is adapted from the [Node.js project](https://github.com/nodejs/node/blob/master/doc/guides/contributing/pull-requests.md#dependencies), check it out for more details.
8 changes: 8 additions & 0 deletions MAINTAINERS_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# `c8` Maintainers Guide

- Label the issues appropriately, see the list of labels and their description [here](https://github.com/bcoe/c8/labels)
- Be welcoming to first-time contributors, identified by the GitHub `first-time contributor` badge.
- At least 1 - 2 _collaborators_ must approve a pull request before the pull request lands.
- PRs with commits that don't follow the [conventional commits standard](https://www.conventionalcommits.org) should be re-written when merging (squash and merge).
- Use Github's _squash and merge_ when landing PRs.
- CI must pass before landing PRs.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,8 @@ A fully functional code coverage solution using only V8's native coverage
features and minimal user-land modules, so that we fit these constraints:

* No parsing of JavaScript code.
* No mucking with Node.js' runtime environment.
* No mucking with Node.js' runtime environment.

## Contributing to `c8`

See the [contributing guide here](./CONTRIBUTING.md).