Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 4.14 KB

CONTRIBUTING.md

File metadata and controls

84 lines (58 loc) · 4.14 KB

Contributing 😃

Thank you very much for taking your time to contribute 😁

Following a few guidelines so that others can quickly benefit from your contribution.

Table of Content:

Code of Conduct

This project and everyone participating in it is governed by Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behaviour to ensino.devops@gmail.com

How to Contribute

  • Star this repository if you like it.

  • Do you want share you challenge?
    Share a new challenge.

  • Do you have a recommendation for some of our challenges?
    Share a new recommendation.

  • Did you find a bug?
    Open an issue.

  • There is a topic missing?
    Create a topic request.

  • Found spelling mistakes?
    Nice catch 🔍 Please fix it and create a pull request.

  • You have other ideas how this project could be improved?
    Contact us on slack, we are looking forward to your ideas.

In any case, if you are uncertain how you can contribute, then contact us on slack and we will try to figure it out together 😄

Your First Contribution

Fantastic, thanks for your effort!

Fork the repository to your repositories (see Fork a repo for help).

Perfect, you are setup and ready to go.

Git

Dealing with Git for the first time? Here are some recommendations for how to set up Git when working on an issue:

  • create a new branch for the issue using git checkout -b <branch-name> (preferably, the branch name should be descriptive of the issue or the change being made, e.g #108-path-exists.) Working on a new branch makes it easier to make more than one pull request.
  • add this repository as a remote repository using git remote add upstream https://github.com/devops-education/Challenges-in-Devops-Education.git. You will use this to fetch changes made in this repository.
  • to ensure your branch is up-to-date, rebase your work on upstream/master using git rebase upstream/master or git pull -r upstream master. This will add all new changes in this repository into your branch and place your local unpushed changes at the top of the branch.

You can read more on Git here.

Contact us on slack whenever you have questions or simply write in the issue.

We recommend you create a pull request (see About pull requests for help) in case you are not sure how you should do something. This way we can give you fast feedback regarding multiple things (style, does it go in the right direction etc.) before you spend time for nothing. Prepend the title with [WIP] (work in progress) in this case and leave a comment with your questions.

Finally, when you think your PR (short for pull request) is ready, then please:

  1. read the Pull Request Checklist
  2. Create your first pull-request
  3. 👏👏👏 you have submitted your first contribution to this project 😊

Pull Request

Please make sure you can your pull request is rebased on the latest commit on master before you create a pull request.