Skip to content

Latest commit

 

History

History
97 lines (51 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

97 lines (51 loc) · 2.94 KB

Contributing

Contributing to this project should be as easy and transparent as possible.

How to contribute

If you'd like to contribute, start by searching through the pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed or to improve something, you can feel free to send a pull request.


Workflow

Repositories use GitHub Flow, so all code changes happen through pull requests. In summary, if you want to contribute to a project, the simplest way is, after clone the repository:


  • Create a branch

Create a branch in your repository, a space to work without affecting the default branch.

git checkout -b your-branch-name

  • Make changes

Your branch is a safe place to make changes. If you make a mistake, your changes will not end up on the default branch until you merge your branch.


  • Commit and push

Commit and push changes to your branch until you are ready to ask for feedback.


  • Create a pull request

Create a pull request to ask collaborators for feedback on your changes, include a summary of the changes and what problem they solve.

--> Click on 'Compare & pull request'

--> Click on 'Create pull request' to serve the changes


  • Address review comments

Reviewers can comment on the whole pull request or add comments to specific lines. You can continue to commit and push changes in response to the reviews.


  • Merge your pull request

Once your pull request is approved, merge your pull request. This will automatically merge your branch so that your changes appear on the default branch.


  • Delete your branch

After you merge your pull request, delete your branch. This indicates that the work on the branch is complete and prevents you or others from accidentally using old branches.


Open Source Guides

Thanks for checking out the Open Source Guides.

Your experiences will benefit others who read and use these guides and following guidelines to help you figure out where you can best be helpful.

  • Open Source Guides are released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Please ensure that your contribution passes all tests if you open a pull request. If there are test failures, you will need to address them before we can merge your contribution.


Additional Resources



. . .

This CONTRIBUTING file was updated
Last refresh: Sunday, 11 August, 18:12 CET