-
Notifications
You must be signed in to change notification settings - Fork 201
CHORE: Update missing or outdated files #6842
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pyansys-automation
wants to merge
4
commits into
main
Choose a base branch
from
maint/update-files
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+25
−26
Open
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
77c3b45
chore: update CODE_OF_CONDUCT.md file
pyansys-automation 8677242
chore: update CONTRIBUTING.md file
pyansys-automation 8305e01
chore: adding changelog file 6842.maintenance.md [dependabot-skip]
pyansys-ci-bot 92ad050
Update CONTRIBUTING.md
SMoraisAnsys File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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,49 +1,12 @@ | ||
| # Contributing | ||
| # Contribute | ||
|
|
||
| We absolutely welcome any code contributions and we hope that this | ||
| guide will facilitate an understanding of the PyAEDT code | ||
| repository. It is important to note that while the PyAEDT software | ||
| package is maintained by ANSYS and any submissions will be reviewed | ||
| thoroughly before merging, we still seek to foster a community that can | ||
| support user questions and develop new features to make this software | ||
| a useful tool for all users. As such, we welcome and encourage any | ||
| questions or submissions to this repository. | ||
| Overall guidance on contributing to a PyAnsys library appears in the | ||
| [Contributing] topic in the *PyAnsys developer's guide*. Ensure that you | ||
| are thoroughly familiar with this guide before attempting to contribute to | ||
| {project-name}. | ||
|
|
||
| For contributing to this project, please refer to the [PyAnsys Developer's Guide]. | ||
| The following contribution information is specific to {project-name}. | ||
|
|
||
| [PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/index.html | ||
| [Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html | ||
|
|
||
| ## Directing Issues and Features Requests | ||
|
|
||
| For reporting bugs and proposing new features, please use the Issues tab instead of the Discussions tab. This will help us track and prioritize work in a more organized manner. | ||
|
|
||
| ## Purpose of Discussions | ||
|
|
||
| The Discussions tab should primarily be used for general questions and discussions about the project. This could include discussions about potential improvements, the future direction of the project, brainstorming ideas, help with using the software, and other topics that don't exactly fit as an Issue. | ||
|
|
||
| Remember, maintaining distinct places for different types of interactions helps keep our project organized and moving forward in a coordinated manner. | ||
|
|
||
| ## Modify the Code | ||
|
|
||
| Everyone can contribute to this project, irrespective of their level of expertise. Your diverse skills, perspectives, and experiences are valuable and we welcome them. | ||
|
|
||
| Here's a simple 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 need to download the repository to your local machine. This can be done using the `git clone` command. | ||
|
|
||
| **Create a New Branch:** A branch is used to isolate your changes from the main project. You can create a new 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 need to "commit" them. A commit is a packaged set of alterations. Use `git add` to add your files to staging, and then `git commit -m "your message"` to commit them. | ||
|
|
||
| **Push Your Changes:** After committing your changes, "push" them to your forked repository on GitHub with `git push origin <branch-name>`. | ||
|
|
||
| **Create a Pull Request:** A Pull Request (PR) lets us know you have changes you think should be included in the main project. Go to your forked repository on GitHub and click on the 'Pull request' button. The title of your | ||
| 'Pull request' must follow the `conventional commits standard <https://github.com/commitizen/conventional-commit-types/blob/master/index.json>`_ where the type field is expected to be defined with upper cases. | ||
|
|
||
| Following these steps ensures that your contributions will 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 these rules will make the Discussions section a better place for every contributor. | ||
| <!-- Begin content specific to your library here. --> | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Update missing or outdated files |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.