forked from bloomberg/collectdwin
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of ssh://github.com/Netuitive/collectdwin
- Loading branch information
Showing
1 changed file
with
21 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,21 @@ | ||
Contributing to the Netuitive Windows Agent | ||
====================================== | ||
|
||
### Workflow for contributing | ||
|
||
1. Create a branch directly in this repo or a fork (if you don't have push access). Please name branches within this repository `feature/<description>` or `fix/description`. For example, something like `feature/upgrade_agent_0.2.3-70`. | ||
|
||
1. Create an issue or open a pull request (PR). If you aren't sure your PR will solve the issue or may be controversial, we're okay with you opening an issue separately and linking to it in your PR. That way, if the PR is not accepted, the issue will remain and be tracked. | ||
|
||
1. Close (and reference) issues by the `closes #XXX` or `fixes #XXX` notation in the commit message. Please use a descriptive, useful commit message that could be used to understand why a particular change was made. Keep pushing commits to the initial branch using `--amend`/`--rebase` as necessary, and don't mix unrelated issues in a single branch. | ||
|
||
1. Clean up the branch (rebase with master to synchronize, squash, edit commits, etc.) to prepare for it to be merged. | ||
|
||
### Merging contributions | ||
|
||
1. After reviewing commits for descriptive commit messages, documentation, passed continuous integration (CI) tests, version bumps, and a changelog, a project maintainer can merge. | ||
|
||
|
||
### Releasing | ||
|
||
1. Create/update the changelog if necessary. |