Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

91 lines (69 loc) · 2.5 KB

Here’s a CONTRIBUTING.md file tailored for your project:

# Contributing to Assert Apex

Thank you for considering contributing to **Assert Apex**! Your help is invaluable in making this project better. Please read through this guide to ensure a smooth contribution process.

---

## **How to Contribute**

### 1. **Fork the Repository**
- Navigate to the [Assert Apex GitHub repository](https://github.com/sjha2048/assert-apex).
- Click the **Fork** button to create your copy of the repository.

### 2. **Clone the Repository**
Clone your forked repository to your local machine:
```bash
git clone https://github.com/<your-username>/assert-apex.git

Replace <your-username> with your GitHub username.

3. Set Up Your Environment

Install dependencies:

npm install

Run tests to ensure everything is working:

npm test

4. Create a Feature Branch

Create a new branch for your feature or bug fix:

git checkout -b feature/your-feature-name

5. Make Changes

  • Write clear and concise code.
  • Follow the existing coding standards and practices.
  • Add tests for any new functionality.

6. Run Tests

Before committing your changes, ensure all tests pass:

npm run lint
npm test

7. Commit Your Changes

Commit your changes with a descriptive commit message:

git add .
git commit -m "Add: Your descriptive message"

8. Push Your Changes

Push your branch to your forked repository:

git push origin feature/your-feature-name

9. Open a Pull Request

  • Navigate to the original repository: Assert Apex.
  • Click New Pull Request.
  • Select your branch and create a detailed description of your changes.

Code of Conduct

Be respectful and professional when engaging with the community. By contributing, you agree to adhere to our Code of Conduct (if available).

Reporting Issues

If you find a bug or have a suggestion, please open an issue. Provide as much detail as possible, including:

  • Steps to reproduce the issue.
  • Expected behavior.
  • Actual behavior.
  • Any additional context or screenshots.

Need Help?

Feel free to reach out by creating an issue or contacting me directly on GitHub: sjha2048.

Thank you for contributing! Your support makes Assert Apex better for everyone.