Skip to content

Commit 8677242

Browse files
chore: update CONTRIBUTING.md file
1 parent 77c3b45 commit 8677242

File tree

1 file changed

+8
-45
lines changed

1 file changed

+8
-45
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
1-
# Contributing
1+
# Contribute
22

3-
We absolutely welcome any code contributions and we hope that this
4-
guide will facilitate an understanding of the PyAEDT code
5-
repository. It is important to note that while the PyAEDT software
6-
package is maintained by ANSYS and any submissions will be reviewed
7-
thoroughly before merging, we still seek to foster a community that can
8-
support user questions and develop new features to make this software
9-
a useful tool for all users. As such, we welcome and encourage any
10-
questions or submissions to this repository.
3+
Overall guidance on contributing to a PyAnsys library appears in the
4+
[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
5+
are thoroughly familiar with this guide before attempting to contribute to
6+
{project-name}.
117

12-
For contributing to this project, please refer to the [PyAnsys Developer's Guide].
8+
The following contribution information is specific to {project-name}.
139

14-
[PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/index.html
10+
[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
1511

16-
## Directing Issues and Features Requests
17-
18-
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.
19-
20-
## Purpose of Discussions
21-
22-
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.
23-
24-
Remember, maintaining distinct places for different types of interactions helps keep our project organized and moving forward in a coordinated manner.
25-
26-
## Modify the Code
27-
28-
Everyone can contribute to this project, irrespective of their level of expertise. Your diverse skills, perspectives, and experiences are valuable and we welcome them.
29-
30-
Here's a simple overview of how you can start making contributions:
31-
32-
**Fork the Repository:** "Forking" means creating a personal copy of this repository on your GitHub account.
33-
34-
**Clone the Repository:** After forking, you need to download the repository to your local machine. This can be done using the `git clone` command.
35-
36-
**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.
37-
38-
**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.
39-
40-
**Push Your Changes:** After committing your changes, "push" them to your forked repository on GitHub with `git push origin <branch-name>`.
41-
42-
**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
43-
'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.
44-
45-
Following these steps ensures that your contributions will be easily reviewed and potentially included in the project much faster.
46-
47-
Please don't get discouraged if you find these steps complex, we are here to help you throughout the process.
48-
49-
We hope these rules will make the Discussions section a better place for every contributor.
12+
<!-- Begin content specific to your library here. -->

0 commit comments

Comments
 (0)