Report bugs for PesXChange by first checking existing issues to avoid duplicates. When submitting a report, provide clear and detailed information to help maintainers reproduce and resolve the issue.
For enhancements (new features or improvements), check existing issues first. If already suggested, comment there instead of creating a new one.
The process described here has several goals:
- Maintain PesXChange's quality
- Fix problems that are important to users
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- After you submit your pull request, verify that all status checks are passing
Ready to contribute? Here’s how to set up PesXChange for local development.
-
Fork the repository.
-
Clone your fork:
git clone https://github.com/your-username/PesXChange
-
Install dependencies: Navigate to the project directory and install the necessary dependencies.
cd PesXChange npm install -
Set up environment variables: Create a
.env.localfile in the root of the project and add any required environment variables. You can use.env.exampleas a template. -
Run the development server:
npm run dev
-
Create a new branch for your changes:
git checkout -b name-of-your-feature-or-fix
-
Make your changes, and commit them with a descriptive message along with screenshots.
-
Push your changes to your fork and open a pull request!
We use Conventional Commits for our commit messages. This allows for easier tracking of changes and automated changelog generation.
For example:
feat: Add user profile pagefix: Correct spelling in the main headingdocs: Update CONTRIBUTING.md