Skip to content

Commit

Permalink
remove todo's
Browse files Browse the repository at this point in the history
  • Loading branch information
sgbaird committed Jun 22, 2022
1 parent f52e69a commit fb4edc6
Showing 1 changed file with 3 additions and 45 deletions.
48 changes: 3 additions & 45 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,3 @@
```{todo} THIS IS SUPPOSED TO BE AN EXAMPLE. MODIFY IT ACCORDING TO YOUR NEEDS!
The document assumes you are using a source repository service that promotes a
contribution model similar to [GitHub's fork and pull request workflow].
While this is true for the majority of services (like GitHub, GitLab,
BitBucket), it might not be the case for private repositories (e.g., when
using Gerrit).
Also notice that the code examples might refer to GitHub URLs or the text
might use GitHub specific terminology (e.g., *Pull Request* instead of *Merge
Request*).
Please make sure to check the document having these assumptions in mind
and update things accordingly.
```

```{todo} Provide the correct links/replacements at the bottom of the document.
```

```{todo} You might want to have a look on [PyScaffold's contributor's guide],
especially if your project is open source. The text should be very similar to
this template, but there are a few extra contents that you might decide to
also include, like mentioning labels of your issue tracker or automated
releases.
```

# Contributing

Welcome to `xtal2png` contributor's guide.
Expand Down Expand Up @@ -174,9 +147,6 @@ conda activate xtal2png

to be able to import the package under development in the Python REPL.

```{todo} if you are not using pre-commit, please remove the following item:
```

5. Install [pre-commit]:

```
Expand Down Expand Up @@ -211,9 +181,6 @@ conda activate xtal2png

to record your changes in [git].

```{todo} if you are not using pre-commit, please remove the following item:
```

Please make sure to see the validation messages from [pre-commit] and fix
any eventual issues.
This should automatically use [flake8]/[black] to check/fix the code style
Expand Down Expand Up @@ -255,13 +222,10 @@ conda activate xtal2png
2. Go to the web page of your fork and click "Create pull request"
to send your changes for review.

```{todo} if you are using GitHub, you can uncomment the following paragraph

Find more detailed information in [creating a PR]. You might also want to open
the PR as a draft first and mark it as ready for review after the feedbacks
from the continuous integration (CI) system or any required fixes.
```
Find more detailed information in [creating a PR]. You might also want to open
the PR as a draft first and mark it as ready for review after the feedbacks
from the continuous integration (CI) system or any required fixes.

### Troubleshooting

Expand Down Expand Up @@ -320,12 +284,6 @@ package:

### Releases

```{todo} This section assumes you are using PyPI to publicly release your package.
If instead you are using a different/private package index, please update
the instructions accordingly.
```

If you are part of the group of maintainers and have correct user permissions
on [PyPI], the following steps can be used to release a new version for
`xtal2png`:
Expand Down

0 comments on commit fb4edc6

Please sign in to comment.