Skip to content

Latest commit

 

History

History
41 lines (20 loc) · 1.98 KB

CONTRIBUTING.rst

File metadata and controls

41 lines (20 loc) · 1.98 KB

# Welcome to Scipion docs contributing guide <!-- omit in toc -->

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [scipion-em.github.io/docs](https://scipion-em.github.io/docs) ✨.

Read our [Code of Conduct](CODE_OF_CONDUCT.rst) to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

## Getting started

For more information on how we write our markdown files, see [the GitHub Markdown reference](https://github.com/github/docs/blob/main/contributing/content-markup-reference.md).

### Issues

#### Create a new issue

If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/scipion-em/docs/issues/new/choose).

#### Solve an issue

Scan through our [existing issues](https://github.com/scipion-em/docs/issues) to find one that interests you. You can narrow down the search using labels as filters. See [Labels](https://github.com/github/docs/blob/main/contributing/how-to-use-labels.md) for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

### Make Changes

  1. Create a working branch and start with your changes!

### Commit your update

Commit the changes once you are happy with them.

### Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

### Your PR is merged! Congratulations

Congratulations 🎉🎉 The Scipion team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the [scipion docs](https://scipion-em.github.io/docs).