Skip to content

Commit

Permalink
Remove forking section
Browse files Browse the repository at this point in the history
  • Loading branch information
hmelder committed Nov 6, 2023
1 parent b284f89 commit 5a49035
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,15 @@ Maintain this format to ensure proper flashcard generation.
### Guidelines
We welcome contributions from TUM students to enhance and expand the AnkiTUM flashcard collection. To contribute, follow these guidelines:

1. **Fork the Repository:** Start by forking the AnkiTUM repository to your GitHub account.
2. **Create Your Flashcards:** Add or edit markdown files following the specified format for decks (h1 tags) and cards (h2 tags and content).
3. **Test Locally:** Generate the flashcards locally using the provided instructions to ensure they are formatted correctly.
4. **Commit Your Changes:** Once you've tested your flashcards, commit the changes to your forked repository.
5. **Submit a Pull Request (PR):** Create a PR against the main AnkiTUM repository. Include a clear description of your changes and any other relevant information.
6. **Review:** Wait for a repository maintainer to review your PR. Be responsive to any feedback or required changes.
1. **Create Your Flashcards:** Add or edit markdown files following the specified format for decks (h1 tags) and cards (h2 tags and content).
2. **Test Locally:** Generate the flashcards locally using the provided instructions to ensure they are formatted correctly.
3. **Commit Your Changes:** Once you've tested your flashcards, commit the changes to your forked repository.
4. **Submit a Pull Request (PR):** Create a PR against the main AnkiTUM repository. Include a clear description of your changes and any other relevant information.
5. **Review:** Wait for a repository maintainer to review your PR. Be responsive to any feedback or required changes.

### Best Practices
- Ensure your flashcards are accurate and relevant to the CS modules.
- Check for duplicates to avoid redundant content.
- Keep your markdown files organized by module and topic.

By following these guidelines, you'll help maintain the quality and usefulness of the AnkiTUM flashcard repository for all students. Your contributions are greatly appreciated!
By following these guidelines, you'll help maintain the quality and usefulness of the AnkiTUM flashcard repository for all students. Your contributions are greatly appreciated!

0 comments on commit 5a49035

Please sign in to comment.