diff --git a/pr_guidelines.md b/CONTRIBUTING.md similarity index 88% rename from pr_guidelines.md rename to CONTRIBUTING.md index 3e8d3509..e456a453 100644 --- a/pr_guidelines.md +++ b/CONTRIBUTING.md @@ -1,4 +1,19 @@ -# Pull Request Guidelines +# Contributing to CloudEvents' Java SDK + +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: + +We welcome contributions from the community! Please take some time to become +acquainted with the process before submitting a pull request. There are just +a few things to keep in mind. + +# Pull Requests + +Typically, a pull request should relate to an existing issue. If you have +found a bug, want to add an improvement, or suggest an API change, please +create an issue before proceeding with a pull request. For very minor changes +such as typos in the documentation this isn't really necessary. + +## Pull Request Guidelines Here you will find step by step guidance for creating, submitting and updating a pull request in this repository. We hope it will help you have an easy time diff --git a/maintainer_guidelines.md b/MAINTAINERS.md similarity index 96% rename from maintainer_guidelines.md rename to MAINTAINERS.md index 220e83b8..46e18444 100644 --- a/maintainer_guidelines.md +++ b/MAINTAINERS.md @@ -1,3 +1,9 @@ +# Maintainers + +Currently, active maintainers who may be found in the CNCF Slack. + +- [Pierangelo Di Pilato](https://github.com/pierDipi) + # Maintainer's Guide ## Release Process