We welcome contributions from the community to help improve and grow this project. Whether you're updating content, reporting a bug, suggesting new features, or contributing code, your input is valuable to us.
Please take a moment to read this document to understand how you can contribute effectively.
Table of Contents
- Code of Conduct
- How to Contribute
- Getting Started
- Development Setup
- Submitting a Pull Request
Code of Conduct
How to Contribute
If you encounter a bug, please check the Issue Tracker to see if it has already been reported. If not, please open a new issue and provide the following information:
- A clear and descriptive title.
- A detailed description of the issue, including steps to reproduce (if applicable).
- Information about your environment (e.g., operating system, browser, version).
- Any relevant screenshots or error messages.
We welcome feature requests! To request a new feature, please create an issue on the Issue Tracker with the following:
- A clear and concise title.
- A detailed description of the feature you're proposing.
We appreciate contributions in the form of code changes, bug fixes, or new features. To contribute code:
- Fork the repository.
- Clone your fork to your local machine:
git clone [email protected]:justanotherengineer/jae.git
- Create a new branch:
git checkout -b my-feature-branch
- Make your changes and test them thoroughly.
- Commit your changes:
git commit -m "Add my new feature"
- Push your branch to your fork:
git push origin my-feature-branch
- Open a Merge Request on the GitLab Repository with a clear title and description.
If you're new to contributing to open source projects, you can start by looking at the good first issue label on our issue tracker. These are issues that are a good entry point for new contributors.
If you want to set up a development environment, refer to the Development for detailed instructions.
Submitting a Pull Request
When submitting a pull request, make sure it meets the following criteria:
- Your code is well-documented.
- It follows the project's coding guidelines.
- All tests pass successfully.
- It addresses an existing issue or fulfills a documented feature request.
Please be patient during the review process. Reviewers will provide feedback, and you may need to make changes before your pull request is merged.
By contributing to Just Another Engineer, you agree that your contributions will be licensed under the MIT License.