Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NO-ISSUE: Contributing file. #2662

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

danielzhe
Copy link
Contributor

No description provided.

@danielzhe danielzhe added the pr: DO NOT MERGE Draft PR, not ready for merging label Oct 14, 2024
@tiagobento
Copy link
Contributor

As discussed, please move these instructions to repo/MANUAL.md. Thanks @danielzhe !

@tiagobento tiagobento added the pr: wip PR is still under development label Oct 17, 2024
@tiagobento
Copy link
Contributor

I'll try and revisit this PR soon... since we introduced __intellij-project for (mostly) Maven-based packages.

@tiagobento tiagobento self-assigned this Jan 20, 2025
# Contributing

All contributions are welcome!
But if you want to contribute to the project, there are some guidelines you should follow to prevent issues that may delay your progress.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My suggestion would be to add some general steps here to follow, could be there are elsewhere already so just reference to therm?
In general, something like:

  1. Setup local development environment like this ....
  2. Before working on your contribution create an issue like this ....
  3. Submit a PR with tests like this ...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good points @domhanak. I'll try and take the contents of this file @danielzhe started and re-structure them in a way that separates ways to contribute from setting up your local dev env... not everyone wants to contribute with code, so there's that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: DO NOT MERGE Draft PR, not ready for merging pr: wip PR is still under development
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants