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

Be more explicit, that contributions are expected to follow code conventions #1458

Conversation

matthiasblaesing
Copy link
Member

No description provided.

@matthiasblaesing
Copy link
Member Author

@dbwiddis as #1454 we can't expect people to follow simple requests if not spelled explicitly. I'm not sure whether or not this is a good change, so I'd like to get your opinion.

@@ -7,7 +7,10 @@ JNA contains work from many developers. You're encouraged to contribute to both
- Fork the code from [github.com/java-native-access/jna](https://github.com/java-native-access/jna)
- Check out the code with `git clone [email protected]:username/jna.git`
- Ensure you can build the project with `ant dist test test-platform`
- Make your code changes, write tests, build
- Make your code changes, write tests, build. New code should follow the
conventions observable in the surrounding code/the codebase. Existing code
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you please explicitly state the conventions you want, for example "Traditional Bean Java Naming conventions". Otherwise you're asking for an undefined Standard, as there is no declared linter, nor linting test within the Testing Pipeline.

Copy link
Contributor

Choose a reason for hiding this comment

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

@Crain-32 See #1473. Would appreciate any input you have there.

@matthiasblaesing
Copy link
Member Author

No - I will not. IMHO it is the job of the reviewers to ensure consistency. I will not put time into specifying it down to the exact specification, else we will get the next discussion. I'll enforce consistency by just fixing it myself it is to much to ask contributors.

@dbwiddis
Copy link
Contributor

I think I can write up a happy medium that does not define explicit formats (that we are a decade too late enforcing) but summarizes some of the unwritten rules to give contributors nonzero guidance.

@matthiasblaesing matthiasblaesing deleted the contribution_clearing branch August 13, 2022 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants