From 35fba8c45feec508b2fd5e2cf37ee45685d66c41 Mon Sep 17 00:00:00 2001 From: Torsten Friebe Date: Fri, 7 Sep 2018 13:26:54 +0200 Subject: [PATCH] Updated contribution guidelines removing references to old infrastructure and fixing formatting for git commands --- CONTRIB.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIB.md b/CONTRIB.md index e03ccb99c7..b33607e9b4 100644 --- a/CONTRIB.md +++ b/CONTRIB.md @@ -24,14 +24,14 @@ If you are interested in making a code contribution and would like to learn more Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown! - Find an issue that you are interested in addressing or a feature that you would like to add. -- Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under your-GitHub-username/repository-name. -- Clone the repository to your local machine using `git clone https://github.com/github-username/repository-name.git`. -- Create a new branch for your fix using `git checkout -b branch-name-here`. +- Fork the repository associated with the issue to your GitHub organization or user account. This means that you will have a copy of the repository under `your-github-username/deegree3`. +- Clone the repository to your local machine using `git clone https://github.com/your-github-username/deegree3.git`. +- Create a new branch for your change using `git checkout -b your-branch-name-here`. - Make the appropriate changes for the issue you are trying to address or the feature that you want to add. - Use `git add insert-paths-of-changed-files-here` to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index. -- Use `git commit -m "Insert a short message of the changes made here"` to store the contents of the index with a descriptive message. -- Push the changes to the remote repository using `git push origin branch-name-here`. -- Submit a pull request to the upstream repository. +- Use `git commit -m "Insert a short message of the changes made here with reference to github issue"` to store the contents of the index with a descriptive message. +- Push the changes to the remote repository using `git push origin your-branch-name-here`. +- Submit a pull request to the upstream repository using the github functionality. - Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Fixes #42: WFS returns valid GML for GetFeature with BBOX parameter". - In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it! - Wait for the pull request to be reviewed by a TMC member. @@ -163,7 +163,7 @@ If for any reason a committee member is not able to fully participate then they The technical infrastructure of the deegree initiative is described in [Infrastructure](https://github.com/deegree/deegree3/wiki/Infrastructure). -If a member of the initiative needs access to one of the infrastructure components, the TMC decides upon tracker request and provides access to the Infrastructure. +If a member of the initiative needs access to one of the infrastructure components, the TMC decides upon request and provides access to the infrastructure. #### Ownership of github organisation and projects