-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
15bca4d
commit 39033a4
Showing
4 changed files
with
30 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,30 @@ | ||
Contributing | ||
------------ | ||
|
||
If you want to use special Latex packages add them in tex/preamble.tex | ||
|
||
To add more text, pleas edit **tex/text.tex**. | ||
|
||
**Before committing**, make sure it compiles: | ||
Go to the directory **tex**, here **main.tex** lies. | ||
To compile run **two times** the command **pdflatex main.tex**. | ||
|
||
1. **Fork** the repository. Here is a guide how to do this: | ||
https://help.github.com/en/github/getting-started-with-github/fork-a-repo | ||
2. Before you make changes, make sure you **synchronized** with the repository. | ||
Here is a guide: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork | ||
4. **Edit** the python scripts (implement your improvements). | ||
5. Edit the **version number** in setup.py. | ||
Therefore, somebody could identify, that he is using a package with your changes later on, | ||
this will allow rechecking the results from the past, as every version is saved in git and can be restored. | ||
6. **Install** the package (as in the section "How to install" described). | ||
7. **Restart** your integrated development environment (IDE) | ||
eg. Spyder, VSCode, ... , so the IDE reloads all packages, and the changes are applied | ||
(depends on the IDE, whether this is required). | ||
8. **Test** your code. | ||
9. Git add filenames, git commit -m "comment", **git push** to **your fork**. | ||
10. If you successfully pushed to your repository, there should be a notification, when you log into | ||
the web-version of github, to **pull a request** (this is the inquiry to make your changes applied | ||
to the main repository, so all could profit from your changes). Describe the issue you where solving | ||
and how and why it is solving the problem. | ||
11. Hope that the maintainer approves your work and merges it. | ||
| | ||
| If you want to use special Latex packages add them in tex/preamble.tex | ||
| | ||
| To add more text, pleas edit **tex/text.tex**. | ||
| | ||
| **Before committing**, make sure it compiles: | ||
| Go to the directory **tex**, here **main.tex** lies. | ||
| To compile run **two times** the command **pdflatex main.tex**. | ||
| | ||
| 1. **Fork** the repository. Here is a guide how to do this: | ||
| https://help.github.com/en/github/getting-started-with-github/fork-a-repo | ||
| 2. Before you make changes, make sure you **synchronized** with the repository. | ||
| Here is a guide: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork | ||
| 4. **Edit** the python scripts (implement your improvements). | ||
| 5. Edit the **version number** in setup.py. | ||
| Therefore, somebody could identify, that he is using a package with your changes later on, | ||
| this will allow rechecking the results from the past, as every version is saved in git and can be restored. | ||
| 6. **Install** the package (as in the section "How to install" described). | ||
| 7. **Restart** your integrated development environment (IDE) | ||
| eg. Spyder, VSCode, ... , so the IDE reloads all packages, and the changes are applied | ||
| (depends on the IDE, whether this is required). | ||
| 8. **Test** your code. | ||
| 9. Git add filenames, git commit -m "comment", **git push** to **your fork**. | ||
| 10. If you successfully pushed to your repository, there should be a notification, when you log into | ||
| the web-version of github, to **pull a request** (this is the inquiry to make your changes applied | ||
| to the main repository, so all could profit from your changes). Describe the issue you where solving | ||
| and how and why it is solving the problem. | ||
| 11. Hope that the maintainer approves your work and merges it. |
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters