| 1 | # Contributing to Atomist Open Source Projects
|
| 2 |
|
| 3 | Have something you would like to contribute to this project? Awesome, and thanks for taking time to contribute! Here's what you need to know.
|
| 4 |
|
| 5 |
|
| 6 | Is there an improvement to existing functionality or an entirely new feature you would like to see? Before creating enhancement suggestions, please check the issue list as you might find out that you don't need to create one.
|
| 7 |
|
| 8 | Did you know we have a [Slack community][slack]? This might be a great place to talk through your idea before starting. It allows you to see if anyone else is already working on something similar, having the same issue or to get feedback on your enhancement idea. Discussing things with the community first is likely to make the contribution process a better experience for yourself and those that are maintaining the projects.
|
| 9 |
|
| 10 | [slack]: https://join.atomist.com/
|
| 11 |
|
| 12 | If you do not find an open issue related to your contribution and discussions in the Slack community are positive, the next thing to do is to create an issue in the appropriate GitHub repository.
|
| 13 |
|
| 14 |
|
| 15 | * Before we can accept any code changes into the Atomist codebase, we need to get some of the legal stuff covered. This is pretty standard for open-source projects. We are using [cla-assisant.io](https://cla-assistant.io/) to track our CLA signatures. Please ensure you sign our [Contributor License Agreement (CLA)](https://cla-assistant.io/atomist/rug).
|
| 16 | * Be sure there is an open issue related to the contribution.
|
| 17 | * Code contributions should follow our [coding conventions](http://docs.atomist.com/reference-docs/rug-conventions/).
|
| 18 | * Commit messages should follow the [standard format](http://chris.beams.io/posts/git-commit/) and should include a [reference](https://github.com/blog/957-introducing-issue-mentions) to the open issue they are addressing.
|
| 19 | * All code contributions should be submitted via a [pull request (PR) from a forked GitHub repository](https://guides.github.com/activities/contributing-to-open-source/).
|
| 20 | * Your PR will be reviewed by an Atomist developer.
|
| 21 |
|
| 22 |
|
| 23 |
|
| 24 | Please go through the checklist below before submitting. There's a chance it may have already been reported, or resolved.
|
| 25 |
|
| 26 | * Check if you can reproduce the problem in the latest version of the project.
|
| 27 | * Search the [atomist-community](https://join.atomist.com) Slack community for common questions and problems.
|
| 28 | * Understand which repo the bug should be reported in.
|
| 29 | * Scan the list of issues to see if the problem has previously been reported. If so, you may add a comment to the existing issue rather than creating a new one.
|
| 30 |
|
| 31 |
|
| 32 | You went through the list above and it is still something you would like to report? Then, please provide us with as much of the context, by explaininig the problem and including any additional details that would help maintainers reproduce the problem. The more details you provide in the bug report, the better.
|
| 33 |
|
| 34 | Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide as much information as possible. Feel free to use the [bug report template](#bug-report-template) below if you like.
|
| 35 |
|
| 36 | At a minimum include the following:
|
| 37 |
|
| 38 | * Where did you find the bug? For example, did you encounter the bug using a button, the bot, or the CLI?
|
| 39 | * What version are you using?
|
| 40 | * What command were you using when it happened? (including params where applicable)
|
| 41 |
|
| 42 |
|
| 43 | ```
|
| 44 | [Description of the problem]
|
| 45 |
|
| 46 | **How to Reproduce:**
|
| 47 |
|
| 48 | 1. [First Step]
|
| 49 | 2. [Second Step]
|
| 50 | 3. [n Step]
|
| 51 |
|
| 52 | **Expected behavior:**
|
| 53 |
|
| 54 | [Describe expected behavior here]
|
| 55 |
|
| 56 | **Observed behavior:**
|
| 57 |
|
| 58 | [Describe observed behavior here]
|
| 59 |
|
| 60 | **Screenshots and GIFs**
|
| 61 |
|
| 62 | 
|
| 63 |
|
| 64 | **Project version:** [Enter project version]
|
| 65 | **Atomist CLI version:** [Enter CLI version]
|
| 66 |
|
| 67 | ```
|
| 68 |
|
| 69 |
|
| 70 | This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to code-of-conduct@atomist.com.
|