First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
- Code of Conduct
- Question or Problem?
- Features vs Bugs
- For all Issues
- Submitting an Issue
- 'Needs Triage' issue label
- Before you start working on an Issue
- Submitting a Pull Request (PR)
- Adding a project
- Reviewing a Pull Request
- Coding Rules
- Commit Message Guidelines
And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
- Star the project
- Tweet about it
- Refer this project in your project's readme
- Mention the project at local meetups and tell your friends/colleagues
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to monacodelisa.
Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. Instead, we recommend using Discussions to ask support-related questions.
Not all issues are bug fixes! Please understand the difference between a Feature and a Bug when it comes to issue creation.
- FEATURE - when you are implementing something new that has not been worked on before
- BUG - when you are correcting something that has been worked on before but is not functioning as intended
This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
Before opening an issue, please search through Issues to see if a similar issue has been raised. Existing discussions may provide useful insights or workarounds.
To expedite bug fixes, a minimal reproduction of the issue is required. This concise example helps in swiftly identifying and addressing the problem.
Providing a minimal reproduction is crucial for saving time, increasing the chances of a quick resolution, and ensuring that focus is given to the correct issue.
DO NOT erase the provided issue template! It is intended for you to use, not to replace it with random text.
It is always a good practice to look up existing issues and ensure your new issue matches the established format. This helps maintain consistency and makes it easier for others to understand and collaborate on the issue
Every new issue is tagged with the "needs triage" label, signifying that it requires review and assessment by a core team member. This process ensures that issues are appropriately prioritized and assigned, fostering a collaborative environment where tasks are synchronized to prevent conflicts. While you focus on addressing an issue, it's important to recognize that others may be working on related tasks. Therefore, the "needs triage" label serves as a precautionary measure, indicating that the issue is not yet ready for immediate attention. The issue will be ready to work on, once the "needs triage" label is removed.
Before commencing work on any issue, it is essential to confirm that it has not already been addressed.
Even if the issue is labeled as not implemented, it remains your responsibility to examine the app's codebase and confirm the absence of the issue.
If the chosen issue has already been resolved - no further PRs would be accepted addressing the same issue.
Before you submit your Pull Request (PR) consider the following guidelines:
-
Search BuiltWithAnalog for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.
-
Be sure that there is an issue that describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.
-
Fork the
builtwithanalogrepo. -
In your forked repository, make your changes in a new git branch:
git checkout -b my-fix-branch main
-
Create your patch, including appropriate test cases.
-
Follow the Coding Rules and Commit Message Guidelines.
-
Run the full test suite, as described in the developer documentation, and ensure that all tests pass.
-
Commit your changes using a descriptive commit message.
git commit --all
Note: the optional commit
--allcommand line option will automatically "add" and "rm" edited files. -
Push your branch to GitHub:
git push origin my-fix-branch
-
In GitHub, send a pull request to
TechShowcase/builtwithanalog:main.
DO NOT erase the provided PR template! It is intended for you to use, not to replace it with random text.
It is always a good practice to look up already merged PRs and ensure your new PR matches the established format. This helps maintain consistency and makes it easier for others to understand and collaborate.
If the issue you are working on is an approved request for adding a new project to be featured in BuiltWithAnalog, follow these steps:
-
Make sure that an issue exists for the project and it has been approved by looking for the
approvedlabel on the issue. -
Add the project at the end of the JSON array of projects in the
projects.get.tsfile located insrc/server/routes. -
Ensure the project details are correctly formatted and include all necessary information as per the existing entries.
- Please keep project title's minimal around 15 characters so it doesn't spill on the next line, usually there is no need for that and there is already a tooltip that shows the full developer's name
-
If some data is missing, collect the data before submitting the PR. PRs for projects with missing data will not be accepted.
-
Double-check that the JSON syntax is correct to avoid breaking the data structure.
-
Add a featured image
- open your webpage in a browser
- press on
F11so that the browser contents takes full width - take a full width
16x9aspect ratio screenshot using any screenshot tool - add the image to the root
public/images/projectsfolder
- Include any relevant tests to verify the new project entry if applicable.
Following these steps will ensure that new projects are added correctly and maintain the integrity of the data used by the application.
I reserve the right not to accept pull requests from community members who haven't been good citizens of the community.
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
-
Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
git push origin --delete my-fix-branch
-
Check out the main branch:
git checkout main -f
-
Delete the local branch:
git branch -D my-fix-branch
-
Update your local
mainwith the latest upstream version:git pull --ff upstream main
To ensure consistency throughout the source code and the different app versions, keep these rules in mind as you are working:
Store full components that can be used on their own, in the components folder, examples include:
header,footer,posts,series,post-details,layout,sidenav
Place partial components like dialogs and other smaller reusable components, in the partials folder, examples:
follow-dialog,search-dialog
Keep interfaces in the models folder, examples:
blog-info.ts,post.ts- Avoid duplicating existing interfaces.
- Place services in the
servicesfolder, examples:blog.service.ts,theme.service.ts
- Omitting a pages folder due to the current absence of an extensive component count, that would justify its introduction.
For clarification on component categorization or any other building block, cross-reference with implementations in other app versions or seek guidance through communication.
- For dialogs, ensure the inclusion of the term dialog in the name.
- Maintain consistency with established naming conventions in other app versions.
- Propose suggestions for improved and clearer naming in discussions or comments.
The project utilizes SCSS. Copying and pasting CSS from other sources would be accepted only if it is formatted correctly to comply with SCSS conventions.
rem,%wh,vh,dvwdvh- avoid using
px
The placement for media queries is the standard placement - below all the other styles.
Maintain the project's indentation and formatting. Do not include formatting changes in your PRs, only include code that you have changed. It doesn't look like you have done more when you submit a PR with tons of indentation changes - we all see its just indentation and that makes it even more unpleasant to deal with.
To maintain a clear and organized version history, we follow a standardized commit message convention. This ensures that each commit provides valuable information about the changes made. Please adhere to the following guidelines when crafting your commit messages:
feat(component): add new feature X
fix(component): resolve issue with Y
docs(readme): update installation instructions
refactor(service): restructure data fetching logic
perf(api): optimize data retrieval for faster response
test(component): add unit tests for feature Z
build(pipeline): update dependencies and build scripts
chore: prepare for version 1.0.0 release
revert: revert changes from commit abc123
Mandatory Compliance with Coding Rules and Commit Message Guidelines for PR Merges
Kindly ensure that all pull requests strictly adhere to our Coding Rules and Commit Message Guidelines. Non-compliant PRs must be adjusted prior to acceptance.
Reviewers who approve PRs not in alignment with the Coding Rules and Commit Message Guidelines may face restrictions on their approval privileges.