|
| 1 | +# Contributing to this repo |
| 2 | + |
| 3 | +First, thank you for your interest in contributing to this project! Before you pick up your first issue and start |
| 4 | +changing code, please: |
| 5 | + |
| 6 | +1. Review all documentation for the module you're interested in. |
| 7 | +1. Look through the [issues for this repo](https://github.com/ipfs/go-graphsync/issues) for relevant discussions. |
| 8 | +1. If you have questions about an issue, post a comment in the issue. |
| 9 | +1. If you want to submit changes that aren't covered by an issue, file a new one with your proposal, outlining what problem you found/feature you want to implement, and how you intend to implement a solution. |
| 10 | + |
| 11 | +For best results, before submitting a PR, make sure: |
| 12 | +1. It has met all acceptance criteria for the issue. |
| 13 | +1. It addresses only the one issue and does not make other, irrelevant changes. |
| 14 | +1. Your code conforms to our coding style guide. |
| 15 | +1. You have adequate test coverage (this should be indicated by CI results anyway). |
| 16 | +1. If you like, check out [current PRs](https://github.com/ipfs/go-graphsync/pulls) to see how others do it. |
| 17 | + |
| 18 | +Special Note: |
| 19 | +If editing README.md, please conform to the [standard readme specification](https://github.com/RichardLitt/standard-readme/blob/master/spec.md). |
| 20 | + |
| 21 | +### PR Process |
| 22 | + |
| 23 | +Active development of `go-graphsync` occurs on the `master` branch. All PRs should be made to the `master` branch, which is the default branch on Github. |
| 24 | + |
| 25 | +Before a PR can be merged to `master`, it must: |
| 26 | +1. Pass continuous integration. |
| 27 | +1. Be rebased and up to date with the `master` branch |
| 28 | +1. Be approved by at least one maintainer |
| 29 | + |
| 30 | +When merging normal PRs to `master`, always use squash and merge to maintain a linear commit history. |
| 31 | + |
| 32 | +### Release Process |
| 33 | + |
| 34 | +When creating a new full release, branch off master with a branch named release/*version-number*, where *version-number* is the ultimate tag you intend to create. |
| 35 | + |
| 36 | +Continue to develop on master and merge commits to your release branch as neccesary till the release is ready. |
| 37 | + |
| 38 | +When the release is ready, tag it, then merge the branch back into master so that it is part of the version history of master. Delete the release branch. |
| 39 | + |
| 40 | +### Hotfix Process |
| 41 | + |
| 42 | +Hot-fixes operate just like release branches, except they are branched off an existing tag and should be named hotfix/*version-number*. When ready, they receive their own tag and then are merged back to master, then deleted. |
| 43 | + |
| 44 | +For external reference, his git flow and release process is essentially the [OneFlow git workflow](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow) |
| 45 | + |
| 46 | +Following the release of Filecoin Mainnet, this library will following a semantic versioning scheme for tagged releases. |
| 47 | + |
| 48 | +### Testing |
| 49 | + |
| 50 | +- All new code should be accompanied by unit tests. Prefer focused unit tests to integration tests for thorough validation of behaviour. Existing code is not necessarily a good model, here. |
| 51 | + |
| 52 | +### Conventions and Style |
| 53 | + |
| 54 | +#### Imports |
| 55 | +We use the following import ordering. |
| 56 | +``` |
| 57 | +import ( |
| 58 | + [stdlib packages, alpha-sorted] |
| 59 | + <single, empty line> |
| 60 | + [external packages] |
| 61 | + <single, empty line> |
| 62 | + [go-graphsync packages] |
| 63 | +) |
| 64 | +``` |
| 65 | + |
| 66 | +Where a package name does not match its directory name, an explicit alias is expected (`goimports` will add this for you). |
| 67 | + |
| 68 | +Example: |
| 69 | + |
| 70 | +```go |
| 71 | +import ( |
| 72 | + "context" |
| 73 | + "testing" |
| 74 | + |
| 75 | + cmds "github.com/ipfs/go-ipfs-cmds" |
| 76 | + cid "github.com/ipfs/go-cid" |
| 77 | + ipld "github.com/ipfs/go-ipld-format" |
| 78 | + "github.com/stretchr/testify/assert" |
| 79 | + |
| 80 | + datatransfer "github.com/filecoin-project/go-data-transfer" |
| 81 | + |
| 82 | + "github.com/filecoin-project/go-fil-markets/filestore/file" |
| 83 | +) |
| 84 | +``` |
| 85 | + |
| 86 | +You can run `script/fiximports` to put all your code in the desired format |
| 87 | + |
| 88 | +#### Comments |
| 89 | + |
| 90 | +Comments are a communication to other developers (including your future self) to help them understand and maintain code. Good comments describe the _intent_ of the code, without repeating the procedures directly. |
| 91 | + |
| 92 | +- A `TODO:` comment describes a change that is desired but could not be immediately implemented. It must include a reference to a GitHub issue outlining whatever prevents the thing being done now (which could just be a matter of priority). |
| 93 | +- A `NOTE:` comment indicates an aside, some background info, or ideas for future improvement, rather than the intent of the current code. It's often fine to document such ideas alongside the code rather than an issue (at the loss of a space for discussion). |
| 94 | +- `FIXME`, `HACK`, `XXX` and similar tags indicating that some code is to be avoided in favour of `TODO`, `NOTE` or some straight prose. |
0 commit comments