From d5148876270a27da5115147abafffe421c644035 Mon Sep 17 00:00:00 2001 From: Acey Bunch Date: Fri, 29 May 2015 14:39:39 -0400 Subject: [PATCH] Updated MD files --- ACKNOWLEDGEMENTS.md | 29 +++++++++++++---------------- CONTRIBUTING.md | 36 +++++++++++++++--------------------- LICENSE.md | 4 ++-- README.md | 3 +-- 4 files changed, 31 insertions(+), 41 deletions(-) diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md index 1a0ab80..9af802e 100644 --- a/ACKNOWLEDGEMENTS.md +++ b/ACKNOWLEDGEMENTS.md @@ -1,24 +1,21 @@ -# Acknowledgements -Package management support is provided by NuGet, which is open-source software. +## Acknowledgements -The original software is available from: - http://nuget.codeplex.com/ +######Package management support is provided by NuGet, which is open source software. -This software is available under an Apache License v2.0: - http://nuget.codeplex.com/license +- The original software is available from: [http://nuget.codeplex.com/](http://nuget.codeplex.com/) +- This software is available under an Apache License v2.0: [http://nuget.codeplex.com/license](http://nuget.codeplex.com/license) -Logging is provided by log4net, which is open-source software. +######JSON support is provided by Json.NET, which is open source software. -The original software is available from: - http://logging.apache.org/log4net/ +- The original software is available from: [http://www.newtonsoft.com/json](http://www.newtonsoft.com/json) +- This software is available under a MIT License: [https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md](https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md) -This software is available under an Apache License v2.0: - http://logging.apache.org/log4net/license.html +######Logging is provided by log4net, which is open-source software. -Dependency injection is provided by Ninject, which is open-source software. +- The original software is available from: [http://logging.apache.org/log4net/](http://logging.apache.org/log4net/) +- This software is available under an Apache License v2.0: [http://logging.apache.org/log4net/license.html](http://logging.apache.org/log4net/license.html) -The original software is available from: - http://www.ninject.org/ +######Dependency injection is provided by Ninject, which is open-source software. -This software is available under an Apache License v2.0: - https://github.com/ninject/ninject/blob/master/LICENSE.txt +- The original software is available from: [http://www.ninject.org/](http://www.ninject.org/) +- This software is available under an Apache License v2.0: [https://github.com/ninject/ninject/blob/master/LICENSE.txt](https://github.com/ninject/ninject/blob/master/LICENSE.txt) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c02a45..a78467a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,42 +1,36 @@ -# Contributing to VersionOne Integration for JIRA +# Contributing to VersionOne IssueSync for JIRA 1. [Getting Involved](#getting-involved) 2. [Reporting Bugs](#reporting-bugs) 3. [Contributing Code](#contributing-code) - 4. [Quality Bands](#quality-bands) ## Getting Involved -We need your help to make VersionOne Integration for JIRA a useful integration. While third-party patches are absolutely essential, they are not the only way to get involved. You can help the project by discovering and [reporting bugs](#reporting-bugs) and helping others on the [versionone-dev group](http://groups.google.com/group/versionone-dev/) and [GitHub issues][issues]. +We need your help to making VersionOne IssueSync for JIRA a useful integration! While third-party patches are absolutely essential, they are not the only way to get involved. You can help the project by discovering and [reporting bugs](#reporting-bugs), helping others on [StackOverflow](http://stackoverflow.com/questions/tagged/versionone), and reporting defects or enhancement requests as [GitHub issues](https://github.com/versionone/VersionOne.Integration.JIRA/issues). ## Reporting Bugs -Before reporting a bug on the project's [issues page][issues], first make sure that your issue is caused by VersionOne Integration for Buy A Feature, not your application code (e.g. passing incorrect arguments to methods, etc.). Second, search the already reported issues for similar cases, and if it has been reported already, just add any additional details in the comments. +Before reporting a bug on the integration's [issues page](https://github.com/versionone/VersionOne.Integration.JIRA/issues), first make sure that your issue is caused by the integration. Second, search the already reported issues for similar cases, and if it has been reported already, just add any additional details in the comments. After you made sure that you have found a new bug, here are some tips for creating a helpful report that will make fixing it much easier and quicker: - * Write a **descriptive, specific title**. Bad: *Problem with filtering*. Good: *Scope.GetThisAndAllChildProjects() always returns an empty list*. - * Whenever possible, include **Class and Method** info in the description. - * Create a **simple test case** that demonstrates the bug (e.g. using [NUnit](http://www.nunit.org/)). - -## Contributing Code - -Coming soon! We are still migrating this project from our private Subversion repository. If you are interested in contributing code to this project, please contact [Ian Buchanan](mailto:ian.buchanan@versionone.com). + * Write a **descriptive, specific title**. Bad: *Problem with filtering*. Good: *Scope.Workitems always returns an empty list*. + * Whenever possible, include **Function** info in the description. + * Create a **simple test case** that demonstrates the bug. -## Quality Bands - -Open source software evolves over time. A young project may be little more than some ideas and a kernel of unstable code. As a project matures, source code, UI, tests, and APIs will become more stable. To help consumers understand what they are getting, we characterize every release with one of the following quality bands. +## Contributing Code -### Seed +### Making Changes to Source -The initial idea of a product. The code may not always work. Very little of the code may be covered by tests. Documentation may be sparse. All APIs are considered "private" and are expected to change. Please expect to work with developers to use and maintain the product. +If you are not yet familiar with the way GitHub works (forking, pull requests, etc.), be sure to read [the article about forking](https://help.github.com/articles/fork-a-repo) on the GitHub Help website — it will get you started quickly. -### Sapling +You should always write each batch of changes (feature, bugfix, etc.) in its own branch. Please do not commit to the `master` branch, or your unrelated changes will go into the same pull request. -The product is undergoing rapid growth. The code works. Test coverage is on the rise. Documentation is firming up. Some APIs may be public but are subject to change. Please expect to inform developers where information is insufficient to self-serve. +You should also follow the code style and whitespace conventions of the original codebase. -### Mature +### Considerations for Accepting Patches -The product is stable. The code will continue to evolve with minimum breaking changes. Documentation is sufficient for self-service. APIs are stable. +Before sending a pull request with a new feature, first check if it has been discussed before already (either on [GitHub issues](https://github.com/versionone/VersionOne.Integration.JIRA/issues). If your feature or improvement did get merged into master, please consider submitting another pull request. -[issues]: https://github.com/versionone/VersionOne.Integration.JIRA/issues \ No newline at end of file +### Open Source Licenses and Attribution +Regardless of whether attribution is required by included code or a dependency, we want to acknowledge the work that VersionOne IssueSync for JIRA depends on and make it easy for people to evaluate the legal implications of using this integration. Therefore, all dependencies should be attributed in the [ACKNOWLEDGEMENTS.md](https://github.com/versionone/VersionOne.Integration.JIRA/blob/master/ACKNOWLEDGEMENTS.md) file. This should include the persons or organizations who contributed the libraries, a link to the source code, and a link to the underlying license. \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md index 74b0bc8..a55306c 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # VersionOne IssueSync for JIRA -Copyright (c) 2015 VersionOne, Inc. -All rights reserved. + +Copyright (c) 2008-2015 [VersionOne](http://versionone.com/). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are diff --git a/README.md b/README.md index ed708ab..0eaabdf 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # VersionOne IssueSync for JIRA -Copyright (c) 2008-2015 [VersionOne](http://versionone.com/). -All rights reserved. +Copyright (c) 2008-2015 [VersionOne](http://versionone.com/). All rights reserved. VersionOne IssueSync for JIRA is a free and open-source integration that creates stories and defects in VersionOne based on issues found in JIRA. Using this integration, an organization can manage and triage issues reported by customers and promote them to VersionOne for their product team to address.