We welcome code contributions and hope that this page explains how you can contribute to the AEDT Antenna Toolkit. While this Python package is maintained by Ansys and any submissions are reviewed thoroughly before merging, we still seek to foster a community that can support user questions and develop new features to make this package a useful tool for all users. As such, we welcome and encourage any questions or submissions to this repository.
For overall information on contributing to this project, see the PyAnsys developer's guide.
To report bugs and propose new features, use the Issues page instead of the Discussions page. This helps us track and prioritize work in a more organized manner.
To post general questions and discussions about the project, use the Discussions page. Posts can include discussions about potential improvements, questions about the future direction of the project, brainstorming of ideas, help with using the package, and other topics that don't exactly fit as an issue.
Remember, maintaining distinct places for different types of interactions helps us to keep our project organized and move forward in a coordinated manner.
Everyone can contribute to this project, regardless of their level of expertise. Your diverse skills, perspectives, and experiences are valuable, and we welcome them.
Here's an overview of how you can start making contributions:
Fork the repository: Forking means creating a personal copy of this repository on your GitHub account.
Clone the repository: After forking, you must download the repository to your local machine. This can be done using the git clone command.
Create a branch: A branch is used to isolate your changes from the main project. You can create a branch using the git branch command. Remember to switch to your new branch with the git checkout command.
Commit your changes: After making your changes, you must "commit" them. A commit is a packaged set of alterations. Use the git add command to add your files to staging, and then use the git commit -m "your message" command to commit them.
Push your changes: After committing your changes, "push" them to your forked repository on GitHub with the git push origin <branch-name> command.
Create a pull request: A pull request (PR) lets us know you have changes that you think should be included in the main project. Go to your forked repository on GitHub and click the Pull request button.
Following these steps ensures that your contributions can be easily reviewed and potentially included in the project much faster.
Please don't get discouraged if you find these steps complex. We are here to help you throughout the process.
We hope that these rules make the Discussions page a better place for every contributor.